Merge branch 'master' into DOC-4235-bitfield-tces

Author: ofekshenawa

doctests/cms_tutorial_test.go

@@ -0,0 +1,84 @@
+// EXAMPLE: cms_tutorial
+// HIDE_START
+package example_commands_test
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/redis/go-redis/v9"
+)
+
+// HIDE_END
+
+func ExampleClient_cms() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+	})
+
+	// REMOVE_START
+	rdb.Del(ctx, "bikes:profit")
+	// REMOVE_END
+
+	// STEP_START cms
+	res1, err := rdb.CMSInitByProb(ctx, "bikes:profit", 0.001, 0.002).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res1) // >>> OK
+
+	res2, err := rdb.CMSIncrBy(ctx, "bikes:profit",
+		"Smoky Mountain Striker", 100,
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res2) // >>> [100]
+
+	res3, err := rdb.CMSIncrBy(ctx, "bikes:profit",
+		"Rocky Mountain Racer", 200,
+		"Cloudy City Cruiser", 150,
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res3) // >>> [200 150]
+
+	res4, err := rdb.CMSQuery(ctx, "bikes:profit",
+		"Smoky Mountain Striker",
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res4) // >>> [100]
+
+	res5, err := rdb.CMSInfo(ctx, "bikes:profit").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Printf("Width: %v, Depth: %v, Count: %v",
+		res5.Width, res5.Depth, res5.Count)
+	// >>> Width: 2000, Depth: 9, Count: 450
+	// STEP_END
+
+	// Output:
+	// OK
+	// [100]
+	// [200 150]
+	// [100]
+	// Width: 2000, Depth: 9, Count: 450
+}

doctests/cuckoo_tutorial_test.go

@@ -0,0 +1,75 @@
+// EXAMPLE: cuckoo_tutorial
+// HIDE_START
+package example_commands_test
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/redis/go-redis/v9"
+)
+
+// HIDE_END
+
+func ExampleClient_cuckoo() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+	})
+
+	// REMOVE_START
+	rdb.Del(ctx, "bikes:models")
+	// REMOVE_END
+
+	// STEP_START cuckoo
+	res1, err := rdb.CFReserve(ctx, "bikes:models", 1000000).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res1) // >>> OK
+
+	res2, err := rdb.CFAdd(ctx, "bikes:models", "Smoky Mountain Striker").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res2) // >>> true
+
+	res3, err := rdb.CFExists(ctx, "bikes:models", "Smoky Mountain Striker").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res3) // >>> true
+
+	res4, err := rdb.CFExists(ctx, "bikes:models", "Terrible Bike Name").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res4) // >>> false
+
+	res5, err := rdb.CFDel(ctx, "bikes:models", "Smoky Mountain Striker").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res5) // >>> true
+	// STEP_END
+
+	// Output:
+	// OK
+	// true
+	// true
+	// false
+	// true
+}

doctests/hll_tutorial_test.go

@@ -0,0 +1,75 @@
+// EXAMPLE: hll_tutorial
+// HIDE_START
+package example_commands_test
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/redis/go-redis/v9"
+)
+
+// HIDE_END
+
+func ExampleClient_pfadd() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+	})
+
+	// REMOVE_START
+	rdb.Del(ctx, "bikes", "commuter_bikes", "all_bikes")
+	// REMOVE_END
+
+	// STEP_START pfadd
+	res1, err := rdb.PFAdd(ctx, "bikes", "Hyperion", "Deimos", "Phoebe", "Quaoar").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res1) // 1
+
+	res2, err := rdb.PFCount(ctx, "bikes").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res2) // 4
+
+	res3, err := rdb.PFAdd(ctx, "commuter_bikes", "Salacia", "Mimas", "Quaoar").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res3) // 1
+
+	res4, err := rdb.PFMerge(ctx, "all_bikes", "bikes", "commuter_bikes").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res4) // OK
+
+	res5, err := rdb.PFCount(ctx, "all_bikes").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res5) // 6
+	// STEP_END
+
+	// Output:
+	// 1
+	// 4
+	// 1
+	// OK
+	// 6
+}