Merge branch 'master' into field-name-spellings

redis · Oct 14, 2024 · 1ca23b5 · 1ca23b5
2 parents f3ef9c9 + 2076975
commit 1ca23b5
Show file tree

Hide file tree

Showing 20 changed files with 3,498 additions and 655 deletions.
diff --git a/doctests/bf_tutorial_test.go b/doctests/bf_tutorial_test.go
@@ -0,0 +1,83 @@
+// EXAMPLE: bf_tutorial
+// HIDE_START
+package example_commands_test
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/redis/go-redis/v9"
+)
+
+// HIDE_END
+
+func ExampleClient_bloom() {
+	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 bloom
+	res1, err := rdb.BFReserve(ctx, "bikes:models", 0.01, 1000).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res1) // >>> OK
+
+	res2, err := rdb.BFAdd(ctx, "bikes:models", "Smoky Mountain Striker").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res2) // >>> true
+
+	res3, err := rdb.BFExists(ctx, "bikes:models", "Smoky Mountain Striker").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res3) // >>> true
+
+	res4, err := rdb.BFMAdd(ctx, "bikes:models",
+		"Rocky Mountain Racer",
+		"Cloudy City Cruiser",
+		"Windy City Wippet",
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res4) // >>> [true true true]
+
+	res5, err := rdb.BFMExists(ctx, "bikes:models",
+		"Rocky Mountain Racer",
+		"Cloudy City Cruiser",
+		"Windy City Wippet",
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res5) // >>> [true true true]
+	// STEP_END
+
+	// Output:
+	// OK
+	// true
+	// true
+	// [true true true]
+	// [true true true]
+}
diff --git a/doctests/bitfield_tutorial_test.go b/doctests/bitfield_tutorial_test.go
@@ -0,0 +1,79 @@
+// EXAMPLE: bitfield_tutorial
+// HIDE_START
+package example_commands_test
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/redis/go-redis/v9"
+)
+
+// HIDE_END
+
+func ExampleClient_bf() {
+	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, "bike:1:stats")
+	// REMOVE_END
+
+	// STEP_START bf
+	res1, err := rdb.BitField(ctx, "bike:1:stats",
+		"set", "u32", "#0", "1000",
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res1) // >>> [0]
+
+	res2, err := rdb.BitField(ctx,
+		"bike:1:stats",
+		"incrby", "u32", "#0", "-50",
+		"incrby", "u32", "#1", "1",
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res2) // >>> [950 1]
+
+	res3, err := rdb.BitField(ctx,
+		"bike:1:stats",
+		"incrby", "u32", "#0", "500",
+		"incrby", "u32", "#1", "1",
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res3) // >>> [1450 2]
+
+	res4, err := rdb.BitField(ctx, "bike:1:stats",
+		"get", "u32", "#0",
+		"get", "u32", "#1",
+	).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res4) // >>> [1450 2]
+	// STEP_END
+
+	// Output:
+	// [0]
+	// [950 1]
+	// [1450 2]
+	// [1450 2]
+}
diff --git a/doctests/bitmap_tutorial_test.go b/doctests/bitmap_tutorial_test.go
@@ -0,0 +1,92 @@
+// EXAMPLE: bitmap_tutorial
+// HIDE_START
+package example_commands_test
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/redis/go-redis/v9"
+)
+
+// HIDE_END
+
+func ExampleClient_ping() {
+	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, "pings:2024-01-01-00:00")
+	// REMOVE_END
+
+	// STEP_START ping
+	res1, err := rdb.SetBit(ctx, "pings:2024-01-01-00:00", 123, 1).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res1) // >>> 0
+
+	res2, err := rdb.GetBit(ctx, "pings:2024-01-01-00:00", 123).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res2) // >>> 1
+
+	res3, err := rdb.GetBit(ctx, "pings:2024-01-01-00:00", 456).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res3) // >>> 0
+	// STEP_END
+
+	// Output:
+	// 0
+	// 1
+	// 0
+}
+
+func ExampleClient_bitcount() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+	})
+
+	// REMOVE_START
+	_, err := rdb.SetBit(ctx, "pings:2024-01-01-00:00", 123, 1).Result()
+
+	if err != nil {
+		panic(err)
+	}
+	// REMOVE_END
+
+	// STEP_START bitcount
+	res4, err := rdb.BitCount(ctx, "pings:2024-01-01-00:00",
+		&redis.BitCount{
+			Start: 0,
+			End:   456,
+		}).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res4) // >>> 1
+	// STEP_END
+
+	// Output:
+	// 1
+}