Skip to content

Commit 5d03e9e

Browse files
DOC-4238 added Cuckoo filter examples (#3116)
Co-authored-by: Vladyslav Vildanov <[email protected]>
1 parent e786862 commit 5d03e9e

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed

doctests/cuckoo_tutorial_test.go

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
// EXAMPLE: cuckoo_tutorial
2+
// HIDE_START
3+
package example_commands_test
4+
5+
import (
6+
"context"
7+
"fmt"
8+
9+
"github.com/redis/go-redis/v9"
10+
)
11+
12+
// HIDE_END
13+
14+
func ExampleClient_cuckoo() {
15+
ctx := context.Background()
16+
17+
rdb := redis.NewClient(&redis.Options{
18+
Addr: "localhost:6379",
19+
Password: "", // no password docs
20+
DB: 0, // use default DB
21+
})
22+
23+
// REMOVE_START
24+
rdb.Del(ctx, "bikes:models")
25+
// REMOVE_END
26+
27+
// STEP_START cuckoo
28+
res1, err := rdb.CFReserve(ctx, "bikes:models", 1000000).Result()
29+
30+
if err != nil {
31+
panic(err)
32+
}
33+
34+
fmt.Println(res1) // >>> OK
35+
36+
res2, err := rdb.CFAdd(ctx, "bikes:models", "Smoky Mountain Striker").Result()
37+
38+
if err != nil {
39+
panic(err)
40+
}
41+
42+
fmt.Println(res2) // >>> true
43+
44+
res3, err := rdb.CFExists(ctx, "bikes:models", "Smoky Mountain Striker").Result()
45+
46+
if err != nil {
47+
panic(err)
48+
}
49+
50+
fmt.Println(res3) // >>> true
51+
52+
res4, err := rdb.CFExists(ctx, "bikes:models", "Terrible Bike Name").Result()
53+
54+
if err != nil {
55+
panic(err)
56+
}
57+
58+
fmt.Println(res4) // >>> false
59+
60+
res5, err := rdb.CFDel(ctx, "bikes:models", "Smoky Mountain Striker").Result()
61+
62+
if err != nil {
63+
panic(err)
64+
}
65+
66+
fmt.Println(res5) // >>> true
67+
// STEP_END
68+
69+
// Output:
70+
// OK
71+
// true
72+
// true
73+
// false
74+
// true
75+
}

0 commit comments

Comments
 (0)