Type-safe Redis client for Golang
Go to file
Aoang c6774f21fc
chore: update CI Test Go version to v1.19
2022-08-14 16:26:49 +08:00
.github chore: update CI Test Go version to v1.19 2022-08-14 16:26:49 +08:00
example chore: release v9.0.0-beta.2 (release.sh) 2022-07-28 15:40:09 +03:00
extra chore: release v9.0.0-beta.2 (release.sh) 2022-07-28 15:40:09 +03:00
fuzz chore: v9 2022-06-04 17:42:06 +03:00
internal test: vet that all Cmders have a SetVal() method 2022-08-07 22:40:51 -07:00
scripts chore: tweak release script 2022-03-17 15:13:56 +02:00
.gitignore Introduce metrics capture with OpenTelemetry (#1398) 2020-07-15 12:07:07 +03: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-beta.2 (release.sh) 2022-07-28 15:40:09 +03:00
LICENSE Fix license. 2016-09-12 12:00:28 +00:00
Makefile test: vet that all Cmders have a SetVal() method 2022-08-07 22:40:51 -07:00
README.md chore: update readme 2022-06-04 18:20:41 +03: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 chore: remove WithContext 2022-06-05 09:58:05 +03:00
cluster.go fix: remove conn reaper from the pool and uptrace option names 2022-07-28 15:17:59 +03:00
cluster_commands.go DBSize,ScriptLoad,ScriptFlush and ScriptExists should use hook (#1811) 2021-07-05 14:40:10 +08:00
cluster_test.go fix: don't panic when test cannot start 2022-07-21 20:10:08 +10:00
command.go chore: fix some command names 2022-08-08 10:28:46 +03:00
command_test.go chore: v9 2022-06-04 17:42:06 +03:00
commands.go chore: fix some command names 2022-08-08 10:28:46 +03:00
commands_test.go chore: v9 2022-06-04 17:42:06 +03:00
doc.go doc: fix outdated reference. 2014-10-07 09:27:55 +03:00
error.go chore: v9 2022-06-04 17:42:06 +03:00
example_instrumentation_test.go chore: v9 2022-06-04 17:42:06 +03:00
example_test.go refactor: remove unused context attribute from conn (#2150) 2022-07-13 08:49:28 +03:00
export_test.go chore: v9 2022-06-04 17:42:06 +03:00
go.mod chore(deps): bump github.com/onsi/gomega from 1.19.0 to 1.20.0 2022-07-25 01:30:21 +00:00
go.sum chore(deps): bump github.com/onsi/gomega from 1.19.0 to 1.20.0 2022-07-25 01:30:21 +00:00
internal_test.go Fix build 2020-05-21 10:03:09 +03: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 fix: remove conn reaper from the pool and uptrace option names 2022-07-28 15:17:59 +03:00
options.go fix: remove conn reaper from the pool and uptrace option names 2022-07-28 15:17:59 +03:00
options_test.go fix: remove conn reaper from the pool and uptrace option names 2022-07-28 15:17:59 +03:00
package.json chore: release v9.0.0-beta.2 (release.sh) 2022-07-28 15:40:09 +03: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 chore: v9 2022-06-04 17:42:06 +03:00
pubsub_test.go fix: remove conn reaper from the pool and uptrace option names 2022-07-28 15:17:59 +03:00
race_test.go chore: remove WithContext 2022-06-05 09:58:05 +03:00
redis.go refactor: remove unused context attributes (#2154) 2022-07-14 13:43:42 +03:00
redis_test.go refactor: remove unused context attribute from conn (#2150) 2022-07-13 08:49:28 +03:00
result.go chore: fix some command names 2022-08-08 10:28:46 +03:00
ring.go fix: remove conn reaper from the pool and uptrace option names 2022-07-28 15:17:59 +03:00
ring_test.go fix: handle panic in ringShards Hash function when Ring got closed 2022-07-13 18:09:42 +03:00
script.go Export scripter interface 2021-01-26 11:57:16 +02:00
sentinel.go fix: remove conn reaper from the pool and uptrace option names 2022-07-28 15:17:59 +03:00
sentinel_test.go chore: v9 2022-06-04 17:42:06 +03:00
tx.go refactor: remove unused context attributes (#2154) 2022-07-14 13:43:42 +03:00
tx_test.go chore: v9 2022-06-04 17:42:06 +03:00
universal.go fix: remove conn reaper from the pool and uptrace option names 2022-07-28 15:17:59 +03:00
universal_test.go chore: v9 2022-06-04 17:42:06 +03:00
version.go chore: release v9.0.0-beta.2 (release.sh) 2022-07-28 15:40:09 +03: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 and blazingly fast distributed tracing tool powered by OpenTelemetry and ClickHouse. Give it a star as well!

Sponsors

Upstash: Serverless Database for Redis

Upstash

Upstash is a Serverless Database with Redis/REST API and durable storage. It is the perfect database for your applications thanks to its per request pricing and low latency data.

Start for free in 30 seconds!


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!