Skip to content

Commit

Permalink
DOC-4322 added HSET/HGET command page examples (#3140)
Browse files Browse the repository at this point in the history
Co-authored-by: ofekshenawa <[email protected]>
  • Loading branch information
andy-stark-redis and ofekshenawa authored Oct 9, 2024
1 parent 7fc46e2 commit 0c84b62
Showing 1 changed file with 133 additions and 0 deletions.
133 changes: 133 additions & 0 deletions doctests/cmds_hash_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
// EXAMPLE: cmds_hash
// HIDE_START
package example_commands_test

import (
"context"
"fmt"

"github.com/redis/go-redis/v9"
)

// HIDE_END

func ExampleClient_hset() {
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, "myhash")
// REMOVE_END

// STEP_START hset
res1, err := rdb.HSet(ctx, "myhash", "field1", "Hello").Result()

if err != nil {
panic(err)
}

fmt.Println(res1) // >>> 1

res2, err := rdb.HGet(ctx, "myhash", "field1").Result()

if err != nil {
panic(err)
}

fmt.Println(res2) // >>> Hello

res3, err := rdb.HSet(ctx, "myhash",
"field2", "Hi",
"field3", "World",
).Result()

if err != nil {
panic(err)
}

fmt.Println(res3) // >>> 2

res4, err := rdb.HGet(ctx, "myhash", "field2").Result()

if err != nil {
panic(err)
}

fmt.Println(res4) // >>> Hi

res5, err := rdb.HGet(ctx, "myhash", "field3").Result()

if err != nil {
panic(err)
}

fmt.Println(res5) // >>> World

res6, err := rdb.HGetAll(ctx, "myhash").Result()

if err != nil {
panic(err)
}

fmt.Println(res6)
// >>> map[field1:Hello field2:Hi field3:World]
// STEP_END

// Output:
// 1
// Hello
// 2
// Hi
// World
// map[field1:Hello field2:Hi field3:World]
}

func ExampleClient_hget() {
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, "myhash")
// REMOVE_END

// STEP_START hget
res7, err := rdb.HSet(ctx, "myhash", "field1", "foo").Result()

if err != nil {
panic(err)
}

fmt.Println(res7) // >>> 1

res8, err := rdb.HGet(ctx, "myhash", "field1").Result()

if err != nil {
panic(err)
}

fmt.Println(res8) // >>> foo

res9, err := rdb.HGet(ctx, "myhash", "field2").Result()

if err != nil {
fmt.Println(err)
}

fmt.Println(res9) // >>> <empty string>
// STEP_END

// Output:
// 1
// foo
// redis: nil
}

0 comments on commit 0c84b62

Please sign in to comment.