Type-safe Redis client for Golang
Go to file
Vladimir Mihailenco 2465baaab5 chore: move sponsors up 2022-05-03 17:50:48 +03:00
.github chore(deps): bump golangci/golangci-lint-action from 2 to 3 2022-04-11 01:27:44 +00:00
example chore: fix links 2022-04-13 15:53:17 +03:00
extra chore: release v8.11.5 (release.sh) 2022-03-17 15:14:48 +02:00
fuzz chore: gofmt all code 2021-09-08 16:52:29 +03:00
internal feat: add WriteArg and Scan net.IP(#2062) 2022-03-28 09:16:12 +08:00
scripts chore: tweak release script 2022-03-17 15:13:56 +02:00
testdata Added backoff retry 2017-05-26 14:33:34 +03: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 v8.11.5 (release.sh) 2022-03-17 15:14:48 +02:00
LICENSE Fix license. 2016-09-12 12:00:28 +00:00
Makefile chore: update dependencies 2021-09-23 16:49:39 +03:00
README.md chore: move sponsors up 2022-05-03 17:50:48 +03:00
RELEASING.md Fix releasing.md 2021-09-03 12:20:59 +03:00
bench_decode_test.go Cleanup and isolate tests 2021-04-16 17:23:20 +03:00
bench_test.go fix: invalid type assert in stringArg 2022-02-18 11:36:04 +08:00
cluster.go chore: lazy reload when moved or ask 2021-10-04 13:16:33 +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 chore: gofmt all code 2021-09-08 16:52:29 +03:00
command.go chore: cleanup 2022-02-18 09:45:35 +02:00
command_test.go chore: gofmt all code 2021-09-08 16:52:29 +03:00
commands.go feat: add support for COPY command (#2016) 2022-02-28 01:07:49 +08:00
commands_test.go feat: add support for COPY command (#2016) 2022-02-28 01:07:49 +08:00
doc.go doc: fix outdated reference. 2014-10-07 09:27:55 +03:00
error.go fix: format 2021-10-04 17:22:18 +02:00
example_instrumentation_test.go Reduce dependency chain 2020-09-17 14:32:08 +01:00
example_test.go Add query parameter parsing to ParseURL() 2021-09-14 18:41:31 +02:00
export_test.go Unexport helper command 2021-03-12 16:08:58 +02:00
go.mod chore(deps): bump github.com/onsi/gomega from 1.18.1 to 1.19.0 (#2063) 2022-03-28 11:15:32 +08:00
go.sum chore(deps): bump github.com/onsi/gomega from 1.18.1 to 1.19.0 (#2063) 2022-03-28 11:15:32 +08:00
internal_test.go Fix build 2020-05-21 10:03:09 +03:00
iterator.go Prevent index out of bunds error 2020-08-07 08:05:47 +02:00
iterator_test.go chore: gofmt all code 2021-09-08 16:52:29 +03:00
main_test.go chore: swap to acl auth at the test-level 2021-09-18 22:36:40 -07:00
options.go Add query parameter parsing to ParseURL() 2021-09-14 18:41:31 +02:00
options_test.go Add query parameter parsing to ParseURL() 2021-09-14 18:41:31 +02:00
package.json chore: release v8.11.5 (release.sh) 2022-03-17 15:14:48 +02:00
pipeline.go chore: add example how to delete keys without a ttl 2021-11-19 17:05:07 +02:00
pipeline_test.go chore: gofmt all code 2021-09-08 16:52:29 +03:00
pool_test.go chore: gofmt all code 2021-09-08 16:52:29 +03:00
pubsub.go Fix Redis Cluster issue during roll outs of new nodes with same addr (#1914) 2021-10-04 13:10:42 +03:00
pubsub_test.go chore: gofmt all code 2021-09-08 16:52:29 +03:00
race_test.go chore: gofmt all code 2021-09-08 16:52:29 +03:00
redis.go chore: lazy reload when moved or ask 2021-10-04 13:16:33 +03:00
redis_test.go feat: add WriteArg and Scan net.IP(#2062) 2022-03-28 09:16:12 +08:00
result.go feat: add NewXPendingResult for unit testing XPending (#2066) 2022-04-05 09:13:39 +03:00
ring.go chore: use ctx parameter in cmdInfo 2021-10-15 14:49:00 +09:00
ring_test.go chore: gofmt all code 2021-09-08 16:52:29 +03:00
script.go Export scripter interface 2021-01-26 11:57:16 +02:00
sentinel.go feat: add acl auth support for sentinels 2021-09-17 23:39:26 -07:00
sentinel_test.go chore: update dependencies 2021-09-23 16:49:39 +03:00
tx.go chore: cleanup OpenTelemetry example 2021-09-08 15:54:10 +03:00
tx_test.go chore: gofmt all code 2021-09-08 16:52:29 +03:00
universal.go feat: add support for acl sentinel auth in universal client 2022-02-28 14:55:37 -08:00
universal_test.go use 3 sentinel instances in unit testing 2020-09-03 12:11:56 -07:00
version.go chore: release v8.11.5 (release.sh) 2022-03-17 15:14:48 +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 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

And then install go-redis/v8 (note v8 in the import; omitting it is a popular mistake):

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

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!