From 5d03e9ec33d5547ec562d174a9856feb09417cd1 Mon Sep 17 00:00:00 2001
From: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com>
Date: Wed, 9 Oct 2024 06:56:44 +0100
Subject: [PATCH] DOC-4238 added Cuckoo filter examples (#3116)

Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com>
---
 doctests/cuckoo_tutorial_test.go | 75 ++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 doctests/cuckoo_tutorial_test.go

diff --git a/doctests/cuckoo_tutorial_test.go b/doctests/cuckoo_tutorial_test.go
new file mode 100644
index 00000000..08a503b1
--- /dev/null
+++ b/doctests/cuckoo_tutorial_test.go
@@ -0,0 +1,75 @@
+// EXAMPLE: cuckoo_tutorial
+// HIDE_START
+package example_commands_test
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/redis/go-redis/v9"
+)
+
+// HIDE_END
+
+func ExampleClient_cuckoo() {
+	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 cuckoo
+	res1, err := rdb.CFReserve(ctx, "bikes:models", 1000000).Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res1) // >>> OK
+
+	res2, err := rdb.CFAdd(ctx, "bikes:models", "Smoky Mountain Striker").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res2) // >>> true
+
+	res3, err := rdb.CFExists(ctx, "bikes:models", "Smoky Mountain Striker").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res3) // >>> true
+
+	res4, err := rdb.CFExists(ctx, "bikes:models", "Terrible Bike Name").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res4) // >>> false
+
+	res5, err := rdb.CFDel(ctx, "bikes:models", "Smoky Mountain Striker").Result()
+
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(res5) // >>> true
+	// STEP_END
+
+	// Output:
+	// OK
+	// true
+	// true
+	// false
+	// true
+}