go/doctests/ss_tutorial_test.go at main

mirror of https://github.com/hanzokv/go.git synced 2026-09-24 00:31:51 +00:00

Files

T

zeekay 6994cf05aa kv, not redis: rename the package, the extras and the URL scheme

We do not use Redis. The client was a go-redis fork and still said so
everywhere: `package redis`, `redis.NewClient`, `redis://`, `extra/redisotel`.
Consumers wrote `redis.Client` against a Valkey-backed store called KV.

  package redis            -> package kv          (93 decls)
  redis.X                  -> kv.X                (2,794 call sites)
  "redis: …" errors        -> "kv: …"             (206)
  extra/redis{otel,cmd,prometheus,census} -> extra/kv{otel,cmd,prometheus,census}
  redis:// , rediss://     -> kv:// , kvs://      (ParseURL)
  Redis*/‌*Redis* idents    -> KV*/*KV*
  REDIS_VERSION, REDIS_ENDPOINTS_CONFIG_PATH -> KV_*

I previously argued this rename was unsafe because much of it was "wire
contract". That was wrong, and the categorisation shows why: RESP command names
are GET/SET/HSET — they never contain the word. Of 5,771 occurrences only two
kinds were server-visible at all: the ParseURL scheme (we choose what we pass;
our configs already use kv://) and the CLIENT SETINFO lib-name label, which the
server merely records. Nothing here changes a byte of protocol.

Two things deliberately keep the old spelling:
  RediSearch  — names a specific external module the FT.* commands map to.
  StoreDist   — contains the letters by accident (sto-reDis-t), not the word.

Breaking for consumers by design: every import site must move redis.X -> kv.X.
Minor bump, never a major — this module stays v9 forever.

2026-07-26 08:34:19 -07:00

454 lines

8.4 KiB

Go

Raw Permalink Blame History

 // EXAMPLE: ss_tutorial
 // HIDE_START
 package example_commands_test
 import (
 	"context"
 	"fmt"
 	"github.com/hanzokv/go/v9"
 )
 // HIDE_END
 func ExampleClient_zadd() {
 	ctx := context.Background()
 	rdb := kv.NewClient(&kv.Options{
 		Addr:     "localhost:6379",
 		Password: "", // no password docs
 		DB:       0,  // use default DB
 	})
 	// REMOVE_START
 	// start with fresh database
 	rdb.FlushDB(ctx)
 	rdb.Del(ctx, "racer_scores")
 	// REMOVE_END
 	// STEP_START zadd
 	res1, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Norem", Score: 10},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res1) // >>> 1
 	res2, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Castilla", Score: 12},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res2) // >>> 1
 	res3, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Norem", Score: 10},
 		kv.Z{Member: "Sam-Bodden", Score: 8},
 		kv.Z{Member: "Royce", Score: 10},
 		kv.Z{Member: "Ford", Score: 6},
 		kv.Z{Member: "Prickett", Score: 14},
 		kv.Z{Member: "Castilla", Score: 12},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res3) // >>> 4
 	// STEP_END
 	// Output:
 	// 1
 	// 1
 	// 4
 }
 func ExampleClient_zrange() {
 	ctx := context.Background()
 	rdb := kv.NewClient(&kv.Options{
 		Addr:     "localhost:6379",
 		Password: "", // no password docs
 		DB:       0,  // use default DB
 	})
 	// REMOVE_START
 	// start with fresh database
 	rdb.FlushDB(ctx)
 	rdb.Del(ctx, "racer_scores")
 	// REMOVE_END
 	_, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Norem", Score: 10},
 		kv.Z{Member: "Sam-Bodden", Score: 8},
 		kv.Z{Member: "Royce", Score: 10},
 		kv.Z{Member: "Ford", Score: 6},
 		kv.Z{Member: "Prickett", Score: 14},
 		kv.Z{Member: "Castilla", Score: 12},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	// STEP_START zrange
 	res4, err := rdb.ZRange(ctx, "racer_scores", 0, -1).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res4)
 	// >>> [Ford Sam-Bodden Norem Royce Castilla Prickett]
 	res5, err := rdb.ZRevRange(ctx, "racer_scores", 0, -1).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res5)
 	// >>> [Prickett Castilla Royce Norem Sam-Bodden Ford]
 	// STEP_END
 	// Output:
 	// [Ford Sam-Bodden Norem Royce Castilla Prickett]
 	// [Prickett Castilla Royce Norem Sam-Bodden Ford]
 }
 func ExampleClient_zrangewithscores() {
 	ctx := context.Background()
 	rdb := kv.NewClient(&kv.Options{
 		Addr:     "localhost:6379",
 		Password: "", // no password docs
 		DB:       0,  // use default DB
 	})
 	// REMOVE_START
 	// start with fresh database
 	rdb.FlushDB(ctx)
 	rdb.Del(ctx, "racer_scores")
 	// REMOVE_END
 	_, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Norem", Score: 10},
 		kv.Z{Member: "Sam-Bodden", Score: 8},
 		kv.Z{Member: "Royce", Score: 10},
 		kv.Z{Member: "Ford", Score: 6},
 		kv.Z{Member: "Prickett", Score: 14},
 		kv.Z{Member: "Castilla", Score: 12},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	// STEP_START zrange_withscores
 	res6, err := rdb.ZRangeWithScores(ctx, "racer_scores", 0, -1).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res6)
 	// >>> [{6 Ford} {8 Sam-Bodden} {10 Norem} {10 Royce} {12 Castilla} {14 Prickett}]
 	// STEP_END
 	// Output:
 	// [{6 Ford} {8 Sam-Bodden} {10 Norem} {10 Royce} {12 Castilla} {14 Prickett}]
 }
 func ExampleClient_zrangebyscore() {
 	ctx := context.Background()
 	rdb := kv.NewClient(&kv.Options{
 		Addr:     "localhost:6379",
 		Password: "", // no password docs
 		DB:       0,  // use default DB
 	})
 	// REMOVE_START
 	// start with fresh database
 	rdb.FlushDB(ctx)
 	rdb.Del(ctx, "racer_scores")
 	// REMOVE_END
 	_, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Norem", Score: 10},
 		kv.Z{Member: "Sam-Bodden", Score: 8},
 		kv.Z{Member: "Royce", Score: 10},
 		kv.Z{Member: "Ford", Score: 6},
 		kv.Z{Member: "Prickett", Score: 14},
 		kv.Z{Member: "Castilla", Score: 12},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	// STEP_START zrangebyscore
 	res7, err := rdb.ZRangeByScore(ctx, "racer_scores",
 		&kv.ZRangeBy{Min: "-inf", Max: "10"},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res7)
 	// >>> [Ford Sam-Bodden Norem Royce]
 	// STEP_END
 	// Output:
 	// [Ford Sam-Bodden Norem Royce]
 }
 func ExampleClient_zremrangebyscore() {
 	ctx := context.Background()
 	rdb := kv.NewClient(&kv.Options{
 		Addr:     "localhost:6379",
 		Password: "", // no password docs
 		DB:       0,  // use default DB
 	})
 	// REMOVE_START
 	// start with fresh database
 	rdb.FlushDB(ctx)
 	rdb.Del(ctx, "racer_scores")
 	// REMOVE_END
 	_, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Norem", Score: 10},
 		kv.Z{Member: "Sam-Bodden", Score: 8},
 		kv.Z{Member: "Royce", Score: 10},
 		kv.Z{Member: "Ford", Score: 6},
 		kv.Z{Member: "Prickett", Score: 14},
 		kv.Z{Member: "Castilla", Score: 12},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	// STEP_START zremrangebyscore
 	res8, err := rdb.ZRem(ctx, "racer_scores", "Castilla").Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res8) // >>> 1
 	res9, err := rdb.ZRemRangeByScore(ctx, "racer_scores", "-inf", "9").Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res9) // >>> 2
 	res10, err := rdb.ZRange(ctx, "racer_scores", 0, -1).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res10)
 	// >>> [Norem Royce Prickett]
 	// STEP_END
 	// Output:
 	// 1
 	// 2
 	// [Norem Royce Prickett]
 }
 func ExampleClient_zrank() {
 	ctx := context.Background()
 	rdb := kv.NewClient(&kv.Options{
 		Addr:     "localhost:6379",
 		Password: "", // no password docs
 		DB:       0,  // use default DB
 	})
 	// REMOVE_START
 	// start with fresh database
 	rdb.FlushDB(ctx)
 	rdb.Del(ctx, "racer_scores")
 	// REMOVE_END
 	_, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Norem", Score: 10},
 		kv.Z{Member: "Royce", Score: 10},
 		kv.Z{Member: "Prickett", Score: 14},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	// STEP_START zrank
 	res11, err := rdb.ZRank(ctx, "racer_scores", "Norem").Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res11) // >>> 0
 	res12, err := rdb.ZRevRank(ctx, "racer_scores", "Norem").Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res12) // >>> 2
 	// STEP_END
 	// Output:
 	// 0
 	// 2
 }
 func ExampleClient_zaddlex() {
 	ctx := context.Background()
 	rdb := kv.NewClient(&kv.Options{
 		Addr:     "localhost:6379",
 		Password: "", // no password docs
 		DB:       0,  // use default DB
 	})
 	// REMOVE_START
 	// start with fresh database
 	rdb.FlushDB(ctx)
 	rdb.Del(ctx, "racer_scores")
 	// REMOVE_END
 	_, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Norem", Score: 0},
 		kv.Z{Member: "Royce", Score: 0},
 		kv.Z{Member: "Prickett", Score: 0},
 	).Result()
 	// STEP_START zadd_lex
 	res13, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Norem", Score: 0},
 		kv.Z{Member: "Sam-Bodden", Score: 0},
 		kv.Z{Member: "Royce", Score: 0},
 		kv.Z{Member: "Ford", Score: 0},
 		kv.Z{Member: "Prickett", Score: 0},
 		kv.Z{Member: "Castilla", Score: 0},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res13) // >>> 3
 	res14, err := rdb.ZRange(ctx, "racer_scores", 0, -1).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res14)
 	// >>> [Castilla Ford Norem Prickett Royce Sam-Bodden]
 	res15, err := rdb.ZRangeByLex(ctx, "racer_scores", &kv.ZRangeBy{
 		Min: "[A", Max: "[L",
 	}).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res15) // >>> [Castilla Ford]
 	// STEP_END
 	// Output:
 	// 3
 	// [Castilla Ford Norem Prickett Royce Sam-Bodden]
 	// [Castilla Ford]
 }
 func ExampleClient_leaderboard() {
 	ctx := context.Background()
 	rdb := kv.NewClient(&kv.Options{
 		Addr:     "localhost:6379",
 		Password: "", // no password docs
 		DB:       0,  // use default DB
 	})
 	// REMOVE_START
 	// start with fresh database
 	rdb.FlushDB(ctx)
 	rdb.Del(ctx, "racer_scores")
 	// REMOVE_END
 	// STEP_START leaderboard
 	res16, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Wood", Score: 100},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res16) // >>> 1
 	res17, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Henshaw", Score: 100},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res17) // >>> 1
 	res18, err := rdb.ZAdd(ctx, "racer_scores",
 		kv.Z{Member: "Henshaw", Score: 150},
 	).Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res18) // >>> 0
 	res19, err := rdb.ZIncrBy(ctx, "racer_scores", 50, "Wood").Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res19) // >>> 150
 	res20, err := rdb.ZIncrBy(ctx, "racer_scores", 50, "Henshaw").Result()
 	if err != nil {
 		panic(err)
 	}
 	fmt.Println(res20) // >>> 200
 	// STEP_END
 	// Output:
 	// 1
 	// 1
 	// 0
 	// 150
 	// 200
 }

454 lines 8.4 KiB Go Raw Permalink Blame History

454 lines

8.4 KiB

Go

Raw Permalink Blame History