DOC-4344 document quickstart examples (#3426)

Author: andy-stark-redis

doctests/search_quickstart_test.go

@@ -0,0 +1,262 @@
+// EXAMPLE: search_quickstart
+// HIDE_START
+package example_commands_test
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/redis/go-redis/v9"
+)
+
+// HIDE_END
+
+var bicycles = []interface{}{
+	map[string]interface{}{
+		"brand": "Velorim",
+		"model": "Jigger",
+		"price": 270,
+		"description": "Small and powerful, the Jigger is the best ride " +
+			"for the smallest of tikes! This is the tiniest " +
+			"kids’ pedal bike on the market available without" +
+			" a coaster brake, the Jigger is the vehicle of " +
+			"choice for the rare tenacious little rider " +
+			"raring to go.",
+		"condition": "new",
+	},
+	map[string]interface{}{
+		"brand": "Bicyk",
+		"model": "Hillcraft",
+		"price": 1200,
+		"description": "Kids want to ride with as little weight as possible." +
+			" Especially on an incline! They may be at the age " +
+			"when a 27.5\" wheel bike is just too clumsy coming " +
+			"off a 24\" bike. The Hillcraft 26 is just the solution" +
+			" they need!",
+		"condition": "used",
+	},
+	map[string]interface{}{
+		"brand": "Nord",
+		"model": "Chook air 5",
+		"price": 815,
+		"description": "The Chook Air 5  gives kids aged six years and older " +
+			"a durable and uberlight mountain bike for their first" +
+			" experience on tracks and easy cruising through forests" +
+			" and fields. The lower  top tube makes it easy to mount" +
+			" and dismount in any situation, giving your kids greater" +
+			" safety on the trails.",
+		"condition": "used",
+	},
+	map[string]interface{}{
+		"brand": "Eva",
+		"model": "Eva 291",
+		"price": 3400,
+		"description": "The sister company to Nord, Eva launched in 2005 as the" +
+			" first and only women-dedicated bicycle brand. Designed" +
+			" by women for women, allEva bikes are optimized for the" +
+			" feminine physique using analytics from a body metrics" +
+			" database. If you like 29ers, try the Eva 291. It’s a " +
+			"brand new bike for 2022.. This full-suspension, " +
+			"cross-country ride has been designed for velocity. The" +
+			" 291 has 100mm of front and rear travel, a superlight " +
+			"aluminum frame and fast-rolling 29-inch wheels. Yippee!",
+		"condition": "used",
+	},
+	map[string]interface{}{
+		"brand": "Noka Bikes",
+		"model": "Kahuna",
+		"price": 3200,
+		"description": "Whether you want to try your hand at XC racing or are " +
+			"looking for a lively trail bike that's just as inspiring" +
+			" on the climbs as it is over rougher ground, the Wilder" +
+			" is one heck of a bike built specifically for short women." +
+			" Both the frames and components have been tweaked to " +
+			"include a women’s saddle, different bars and unique " +
+			"colourway.",
+		"condition": "used",
+	},
+	map[string]interface{}{
+		"brand": "Breakout",
+		"model": "XBN 2.1 Alloy",
+		"price": 810,
+		"description": "The XBN 2.1 Alloy is our entry-level road bike – but that’s" +
+			" not to say that it’s a basic machine. With an internal " +
+			"weld aluminium frame, a full carbon fork, and the slick-shifting" +
+			" Claris gears from Shimano’s, this is a bike which doesn’t" +
+			" break the bank and delivers craved performance.",
+		"condition": "new",
+	},
+	map[string]interface{}{
+		"brand": "ScramBikes",
+		"model": "WattBike",
+		"price": 2300,
+		"description": "The WattBike is the best e-bike for people who still feel young" +
+			" at heart. It has a Bafang 1000W mid-drive system and a 48V" +
+			" 17.5AH Samsung Lithium-Ion battery, allowing you to ride for" +
+			" more than 60 miles on one charge. It’s great for tackling hilly" +
+			" terrain or if you just fancy a more leisurely ride. With three" +
+			" working modes, you can choose between E-bike, assisted bicycle," +
+			" and normal bike modes.",
+		"condition": "new",
+	},
+	map[string]interface{}{
+		"brand": "Peaknetic",
+		"model": "Secto",
+		"price": 430,
+		"description": "If you struggle with stiff fingers or a kinked neck or back after" +
+			" a few minutes on the road, this lightweight, aluminum bike" +
+			" alleviates those issues and allows you to enjoy the ride. From" +
+			" the ergonomic grips to the lumbar-supporting seat position, the" +
+			" Roll Low-Entry offers incredible comfort. The rear-inclined seat" +
+			" tube facilitates stability by allowing you to put a foot on the" +
+			" ground to balance at a stop, and the low step-over frame makes it" +
+			" accessible for all ability and mobility levels. The saddle is" +
+			" very soft, with a wide back to support your hip joints and a" +
+			" cutout in the center to redistribute that pressure. Rim brakes" +
+			" deliver satisfactory braking control, and the wide tires provide" +
+			" a smooth, stable ride on paved roads and gravel. Rack and fender" +
+			" mounts facilitate setting up the Roll Low-Entry as your preferred" +
+			" commuter, and the BMX-like handlebar offers space for mounting a" +
+			" flashlight, bell, or phone holder.",
+		"condition": "new",
+	},
+	map[string]interface{}{
+		"brand": "nHill",
+		"model": "Summit",
+		"price": 1200,
+		"description": "This budget mountain bike from nHill performs well both on bike" +
+			" paths and on the trail. The fork with 100mm of travel absorbs" +
+			" rough terrain. Fat Kenda Booster tires give you grip in corners" +
+			" and on wet trails. The Shimano Tourney drivetrain offered enough" +
+			" gears for finding a comfortable pace to ride uphill, and the" +
+			" Tektro hydraulic disc brakes break smoothly. Whether you want an" +
+			" affordable bike that you can take to work, but also take trail in" +
+			" mountains on the weekends or you’re just after a stable," +
+			" comfortable ride for the bike path, the Summit gives a good value" +
+			" for money.",
+		"condition": "new",
+	},
+	map[string]interface{}{
+		"model": "ThrillCycle",
+		"brand": "BikeShind",
+		"price": 815,
+		"description": "An artsy,  retro-inspired bicycle that’s as functional as it is" +
+			" pretty: The ThrillCycle steel frame offers a smooth ride. A" +
+			" 9-speed drivetrain has enough gears for coasting in the city, but" +
+			" we wouldn’t suggest taking it to the mountains. Fenders protect" +
+			" you from mud, and a rear basket lets you transport groceries," +
+			" flowers and books. The ThrillCycle comes with a limited lifetime" +
+			" warranty, so this little guy will last you long past graduation.",
+		"condition": "refurbished",
+	},
+}
+
+func ExampleClient_search_qs() {
+	// STEP_START connect
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+		Protocol: 2,
+	})
+	// STEP_END
+
+	// REMOVE_START
+	rdb.FTDropIndex(ctx, "idx:bicycle")
+	// REMOVE_END
+
+	// STEP_START create_index
+	schema := []*redis.FieldSchema{
+		{
+			FieldName: "$.brand",
+			As:        "brand",
+			FieldType: redis.SearchFieldTypeText,
+		},
+		{
+			FieldName: "$.model",
+			As:        "model",
+			FieldType: redis.SearchFieldTypeText,
+		},
+		{
+			FieldName: "$.description",
+			As:        "description",
+			FieldType: redis.SearchFieldTypeText,
+		},
+	}
+
+	_, err := rdb.FTCreate(ctx, "idx:bicycle",
+		&redis.FTCreateOptions{
+			Prefix: []interface{}{"bicycle:"},
+			OnJSON: true,
+		},
+		schema...,
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+	// STEP_END
+
+	// STEP_START add_documents
+	for i, bicycle := range bicycles {
+		_, err := rdb.JSONSet(
+			ctx,
+			fmt.Sprintf("bicycle:%v", i),
+			"$",
+			bicycle,
+		).Result()
+
+		if err != nil {
+			panic(err)
+		}
+	}
+	// STEP_END
+
+	// STEP_START wildcard_query
+	wCardResult, err := rdb.FTSearch(ctx, "idx:bicycle", "*").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Printf("Documents found: %v\n", wCardResult.Total)
+	// >>> Documents found: 10
+	// STEP_END
+
+	// STEP_START query_single_term
+	stResult, err := rdb.FTSearch(
+		ctx,
+		"idx:bicycle",
+		"@model:Jigger",
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(stResult)
+	// >>> {1 [{bicycle:0 <nil> <nil> <nil> map[$:{"brand":"Velorim", ...
+	// STEP_END
+
+	// STEP_START query_exact_matching
+	exactMatchResult, err := rdb.FTSearch(
+		ctx,
+		"idx:bicycle",
+		"@brand:\"Noka Bikes\"",
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(exactMatchResult)
+	// >>> {1 [{bicycle:4 <nil> <nil> <nil> map[$:{"brand":"Noka Bikes"...
+	// STEP_END
+
+	// Output:
+	// Documents found: 10
+	// {1 [{bicycle:0 <nil> <nil> <nil> map[$:{"brand":"Velorim","condition":"new","description":"Small and powerful, the Jigger is the best ride for the smallest of tikes! This is the tiniest kids’ pedal bike on the market available without a coaster brake, the Jigger is the vehicle of choice for the rare tenacious little rider raring to go.","model":"Jigger","price":270}]}]}
+	// {1 [{bicycle:4 <nil> <nil> <nil> map[$:{"brand":"Noka Bikes","condition":"used","description":"Whether you want to try your hand at XC racing or are looking for a lively trail bike that's just as inspiring on the climbs as it is over rougher ground, the Wilder is one heck of a bike built specifically for short women. Both the frames and components have been tweaked to include a women’s saddle, different bars and unique colourway.","model":"Kahuna","price":3200}]}]}
+}