mirror of
https://github.com/hanzokv/go.git
synced 2026-09-24 00:31:51 +00:00
zeekay
6994cf05aa
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.
210 lines
4.2 KiB
Go
210 lines
4.2 KiB
Go
// EXAMPLE: geoindex
|
|
// HIDE_START
|
|
package example_commands_test
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
|
|
"github.com/hanzokv/go/v9"
|
|
)
|
|
|
|
// HIDE_END
|
|
|
|
func ExampleClient_geoindex() {
|
|
ctx := context.Background()
|
|
|
|
rdb := kv.NewClient(&kv.Options{
|
|
Addr: "localhost:6379",
|
|
Password: "", // no password docs
|
|
DB: 0, // use default DB
|
|
Protocol: 2,
|
|
})
|
|
|
|
// REMOVE_START
|
|
// make sure we are working with fresh database
|
|
rdb.FlushDB(ctx)
|
|
rdb.FTDropIndex(ctx, "productidx")
|
|
rdb.FTDropIndex(ctx, "geomidx")
|
|
rdb.Del(ctx, "product:46885", "product:46886", "shape:1", "shape:2", "shape:3", "shape:4")
|
|
// REMOVE_END
|
|
|
|
// STEP_START create_geo_idx
|
|
geoCreateResult, err := rdb.FTCreate(ctx,
|
|
"productidx",
|
|
&kv.FTCreateOptions{
|
|
OnJSON: true,
|
|
Prefix: []interface{}{"product:"},
|
|
},
|
|
&kv.FieldSchema{
|
|
FieldName: "$.location",
|
|
As: "location",
|
|
FieldType: kv.SearchFieldTypeGeo,
|
|
},
|
|
).Result()
|
|
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
fmt.Println(geoCreateResult) // >>> OK
|
|
// STEP_END
|
|
|
|
// STEP_START add_geo_json
|
|
prd46885 := map[string]interface{}{
|
|
"description": "Navy Blue Slippers",
|
|
"price": 45.99,
|
|
"city": "Denver",
|
|
"location": "-104.991531, 39.742043",
|
|
}
|
|
|
|
gjResult1, err := rdb.JSONSet(ctx, "product:46885", "$", prd46885).Result()
|
|
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
fmt.Println(gjResult1) // >>> OK
|
|
|
|
prd46886 := map[string]interface{}{
|
|
"description": "Bright Green Socks",
|
|
"price": 25.50,
|
|
"city": "Fort Collins",
|
|
"location": "-105.0618814,40.5150098",
|
|
}
|
|
|
|
gjResult2, err := rdb.JSONSet(ctx, "product:46886", "$", prd46886).Result()
|
|
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
fmt.Println(gjResult2) // >>> OK
|
|
// STEP_END
|
|
|
|
// STEP_START geo_query
|
|
geoQueryResult, err := rdb.FTSearch(ctx, "productidx",
|
|
"@location:[-104.800644 38.846127 100 mi]",
|
|
).Result()
|
|
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
fmt.Println(geoQueryResult)
|
|
// >>> {1 [{product:46885...
|
|
// STEP_END
|
|
|
|
// STEP_START create_gshape_idx
|
|
geomCreateResult, err := rdb.FTCreate(ctx, "geomidx",
|
|
&kv.FTCreateOptions{
|
|
OnJSON: true,
|
|
Prefix: []interface{}{"shape:"},
|
|
},
|
|
&kv.FieldSchema{
|
|
FieldName: "$.name",
|
|
As: "name",
|
|
FieldType: kv.SearchFieldTypeText,
|
|
},
|
|
&kv.FieldSchema{
|
|
FieldName: "$.geom",
|
|
As: "geom",
|
|
FieldType: kv.SearchFieldTypeGeoShape,
|
|
GeoShapeFieldType: "FLAT",
|
|
},
|
|
).Result()
|
|
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
fmt.Println(geomCreateResult) // >>> OK
|
|
// STEP_END
|
|
|
|
// STEP_START add_gshape_json
|
|
shape1 := map[string]interface{}{
|
|
"name": "Green Square",
|
|
"geom": "POLYGON ((1 1, 1 3, 3 3, 3 1, 1 1))",
|
|
}
|
|
|
|
gmjResult1, err := rdb.JSONSet(ctx, "shape:1", "$", shape1).Result()
|
|
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
fmt.Println(gmjResult1) // >>> OK
|
|
|
|
shape2 := map[string]interface{}{
|
|
"name": "Red Rectangle",
|
|
"geom": "POLYGON ((2 2.5, 2 3.5, 3.5 3.5, 3.5 2.5, 2 2.5))",
|
|
}
|
|
|
|
gmjResult2, err := rdb.JSONSet(ctx, "shape:2", "$", shape2).Result()
|
|
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
fmt.Println(gmjResult2) // >>> OK
|
|
|
|
shape3 := map[string]interface{}{
|
|
"name": "Blue Triangle",
|
|
"geom": "POLYGON ((3.5 1, 3.75 2, 4 1, 3.5 1))",
|
|
}
|
|
|
|
gmjResult3, err := rdb.JSONSet(ctx, "shape:3", "$", shape3).Result()
|
|
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
fmt.Println(gmjResult3) // >>> OK
|
|
|
|
shape4 := map[string]interface{}{
|
|
"name": "Purple Point",
|
|
"geom": "POINT (2 2)",
|
|
}
|
|
|
|
gmjResult4, err := rdb.JSONSet(ctx, "shape:4", "$", shape4).Result()
|
|
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
fmt.Println(gmjResult4) // >>> OK
|
|
// STEP_END
|
|
|
|
// STEP_START gshape_query
|
|
geomQueryResult, err := rdb.FTSearchWithArgs(ctx, "geomidx",
|
|
"(-@name:(Green Square) @geom:[WITHIN $qshape])",
|
|
&kv.FTSearchOptions{
|
|
Params: map[string]interface{}{
|
|
"qshape": "POLYGON ((1 1, 1 3, 3 3, 3 1, 1 1))",
|
|
},
|
|
DialectVersion: 4,
|
|
Limit: 1,
|
|
},
|
|
).Result()
|
|
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
fmt.Println(geomQueryResult)
|
|
// >>> {1 [{shape:4...
|
|
// STEP_END
|
|
|
|
// Output:
|
|
// OK
|
|
// OK
|
|
// OK
|
|
// {1 [{product:46885 <nil> <nil> <nil> map[$:{"city":"Denver","description":"Navy Blue Slippers","location":"-104.991531, 39.742043","price":45.99}] <nil>}]}
|
|
// OK
|
|
// OK
|
|
// OK
|
|
// OK
|
|
// OK
|
|
// {1 [{shape:4 <nil> <nil> <nil> map[$:[{"geom":"POINT (2 2)","name":"Purple Point"}]] <nil>}]}
|
|
}
|