Type-safe Redis client for Golang
Go to file
Monkey 09fcdbe6e4
Merge pull request #2344 from monkey92t/hook
docs: add a description of the hook
2023-01-07 16:52:12 +08:00
.github Merge pull request #2075 from turrisxyz/setup-permissions 2022-10-05 10:55:46 +03:00
example chore: cleanup key checker 2022-12-07 10:38:28 +02:00
extra fix(redisotel): correct metrics.DialHook attrs (#2331) 2022-12-23 20:40:07 +08:00
fuzz chore: v9 2022-06-04 17:42:06 +03:00
internal docs: add a description of the hook 2023-01-07 16:30:56 +08:00
scripts chore: go 1.17 compat 2022-10-14 15:19:45 +03:00
.gitignore test: `TestRingSetAddrsContention` changed to Benchmark (#2316) 2022-12-16 23:34:43 +08:00
.golangci.yml chore: don't enable all lints 2021-11-19 17:09:58 +02:00
.prettierrc.yml chore: lazy reload when moved or ask 2021-10-04 13:16:33 +03:00
CHANGELOG.md chore: release v9.0.0-rc.2 (release.sh) 2022-11-26 14:20:33 +02:00
LICENSE Fix license. 2016-09-12 12:00:28 +00:00
Makefile test: upgrade redis version(7.0.7) 2022-12-28 22:38:59 +08:00
README.md docs(README.md): update doc addr, to v9 2023-01-03 18:37:13 +08:00
RELEASING.md Fix releasing.md 2021-09-03 12:20:59 +03:00
bench_decode_test.go chore: v9 2022-06-04 17:42:06 +03:00
bench_test.go test: `TestRingSetAddrsContention` changed to Benchmark (#2316) 2022-12-16 23:34:43 +08:00
cluster.go docs: add a description of the hook 2023-01-07 16:30:56 +08:00
cluster_commands.go feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
cluster_test.go feat: add ClientName option 2022-12-28 22:14:52 +08:00
command.go docs: add a description of the hook 2023-01-07 16:30:56 +08:00
command_test.go chore: v9 2022-06-04 17:42:06 +03:00
commands.go feat: add support for SINTERCARD command 2022-11-21 22:11:23 +08:00
commands_test.go feat(scan): add Scanner interface (#2317) 2022-12-24 22:29:45 +08:00
doc.go doc: fix outdated reference. 2014-10-07 09:27:55 +03:00
error.go feat: add HasErrorPrefix 2022-11-17 16:18:04 +02:00
example_instrumentation_test.go chore: fix examples 2022-10-13 09:12:05 +03:00
example_test.go feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
export_test.go fix: fixes ring.SetAddrs and rebalance race (#2283) 2022-11-21 11:00:00 +02:00
go.mod chore(deps): bump github.com/onsi/gomega from 1.24.1 to 1.24.2 (#2320) 2022-12-19 14:37:49 +08:00
go.sum chore(deps): bump github.com/onsi/gomega from 1.24.1 to 1.24.2 (#2320) 2022-12-19 14:37:49 +08:00
internal_test.go test: add TestRingShardsCleanup 2022-11-22 23:55:13 +01:00
iterator.go fix: remove iterator mutex as it's not needed 2022-08-13 11:05:04 +10:00
iterator_test.go chore: v9 2022-06-04 17:42:06 +03:00
main_test.go feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
options.go docs: add a description of the hook 2023-01-07 16:30:56 +08:00
options_test.go feat: add ClientName option 2022-12-28 22:14:52 +08:00
package.json chore: release v9.0.0-rc.2 (release.sh) 2022-11-26 14:20:33 +02:00
pipeline.go chore: remove WithContext 2022-06-05 09:58:05 +03:00
pipeline_test.go chore: v9 2022-06-04 17:42:06 +03:00
pool_test.go fix: remove conn reaper from the pool and uptrace option names 2022-07-28 15:17:59 +03:00
pubsub.go fix: reset pubsub state when unsubscribing from all channels 2022-10-14 15:15:06 +03:00
pubsub_test.go feat(pubsub): support sharded pub/sub 2022-08-04 00:05:22 +08:00
race_test.go fix: improve pipelines retry logic (#2232) 2022-10-06 14:05:55 +03:00
redis.go docs: add a description of the hook 2023-01-07 16:30:56 +08:00
redis_test.go feat: add ClientName option 2022-12-28 22:14:52 +08:00
result.go chore: fix some command names 2022-08-08 10:28:46 +03:00
ring.go feat: add ClientName option 2022-12-28 22:14:52 +08:00
ring_test.go feat: add ClientName option 2022-12-28 22:14:52 +08:00
script.go feat: add HasErrorPrefix 2022-11-17 16:18:04 +02:00
sentinel.go feat: add ClientName option 2022-12-28 22:14:52 +08:00
sentinel_test.go feat: add ClientName option 2022-12-28 22:14:52 +08:00
tx.go feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
tx_test.go chore: v9 2022-06-04 17:42:06 +03:00
universal.go feat: add ClientName option 2022-12-28 22:14:52 +08:00
universal_test.go chore: v9 2022-06-04 17:42:06 +03:00
version.go chore: release v9.0.0-rc.2 (release.sh) 2022-11-26 14:20:33 +02:00

README.md

Redis client for Go

build workflow PkgGoDev Documentation Chat

go-redis is brought to you by uptrace/uptrace. Uptrace is an open-source APM tool that supports distributed tracing, metrics, and logs. You can use it to monitor applications and set up automatic alerts to receive notifications via email, Slack, Telegram, and others.

See OpenTelemetry example which demonstrates how you can use Uptrace to monitor go-redis.

Resources

Ecosystem

This client also works with Kvrocks, a distributed key value NoSQL database that uses RocksDB as storage engine and is compatible with Redis protocol.

Features

Installation

go-redis supports 2 last Go versions and requires a Go version with modules support. So make sure to initialize a Go module:

go mod init github.com/my/repo

If you are using Redis 6, install go-redis/v8:

go get github.com/go-redis/redis/v8

If you are using Redis 7, install go-redis/v9:

go get github.com/go-redis/redis/v9

Quickstart

import (
    "context"
    "github.com/go-redis/redis/v8"
    "fmt"
)

var ctx = context.Background()

func ExampleClient() {
    rdb := redis.NewClient(&redis.Options{
        Addr:     "localhost:6379",
        Password: "", // no password set
        DB:       0,  // use default DB
    })

    err := rdb.Set(ctx, "key", "value", 0).Err()
    if err != nil {
        panic(err)
    }

    val, err := rdb.Get(ctx, "key").Result()
    if err != nil {
        panic(err)
    }
    fmt.Println("key", val)

    val2, err := rdb.Get(ctx, "key2").Result()
    if err == redis.Nil {
        fmt.Println("key2 does not exist")
    } else if err != nil {
        panic(err)
    } else {
        fmt.Println("key2", val2)
    }
    // Output: key value
    // key2 does not exist
}

Look and feel

Some corner cases:

// SET key value EX 10 NX
set, err := rdb.SetNX(ctx, "key", "value", 10*time.Second).Result()

// SET key value keepttl NX
set, err := rdb.SetNX(ctx, "key", "value", redis.KeepTTL).Result()

// SORT list LIMIT 0 2 ASC
vals, err := rdb.Sort(ctx, "list", &redis.Sort{Offset: 0, Count: 2, Order: "ASC"}).Result()

// ZRANGEBYSCORE zset -inf +inf WITHSCORES LIMIT 0 2
vals, err := rdb.ZRangeByScoreWithScores(ctx, "zset", &redis.ZRangeBy{
    Min: "-inf",
    Max: "+inf",
    Offset: 0,
    Count: 2,
}).Result()

// ZINTERSTORE out 2 zset1 zset2 WEIGHTS 2 3 AGGREGATE SUM
vals, err := rdb.ZInterStore(ctx, "out", &redis.ZStore{
    Keys: []string{"zset1", "zset2"},
    Weights: []int64{2, 3}
}).Result()

// EVAL "return {KEYS[1],ARGV[1]}" 1 "key" "hello"
vals, err := rdb.Eval(ctx, "return {KEYS[1],ARGV[1]}", []string{"key"}, "hello").Result()

// custom command
res, err := rdb.Do(ctx, "set", "key", "value").Result()

Run the test

go-redis will start a redis-server and run the test cases.

The paths of redis-server bin file and redis config file are defined in main_test.go:

var (
	redisServerBin, _  = filepath.Abs(filepath.Join("testdata", "redis", "src", "redis-server"))
	redisServerConf, _ = filepath.Abs(filepath.Join("testdata", "redis", "redis.conf"))
)

For local testing, you can change the variables to refer to your local files, or create a soft link to the corresponding folder for redis-server and copy the config file to testdata/redis/:

ln -s /usr/bin/redis-server ./go-redis/testdata/redis/src
cp ./go-redis/testdata/redis.conf ./go-redis/testdata/redis/

Lastly, run:

go test

See also

Contributors

Thanks to all the people who already contributed!