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

876 B

Raw Permalink Blame History

Command examples for kv.io

These examples appear on the KV documentation site as part of the tabbed examples interface.

How to add examples

Create a Go test file with a meaningful name in the current folder.
Create a single method prefixed with Example and write your test in it.
Determine the id for the example you're creating and add it as the first line of the file: // EXAMPLE: set_and_get.
We're using the Testable Examples feature of Go to test the desired output has been written to stdout.

Special markup

See https://github.com/kv-stack/kv-stack-website#readme for more details.

How to test the examples

Start a KV server locally on port 6379
CD into the doctests directory
Run go test to test all examples in the directory.
Run go test filename.go to test a single file

876 B Raw Permalink Blame History

Command examples for kv.io

How to add examples

Special markup

How to test the examples

876 B

Raw Permalink Blame History