Type-safe Redis client for Golang
Go to file
Vladimir Mihailenco 0dff3d1461 feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
.github Merge pull request #2075 from turrisxyz/setup-permissions 2022-10-05 10:55:46 +03:00
example feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
extra feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
fuzz chore: v9 2022-06-04 17:42:06 +03:00
internal feat: add ContextTimeoutEnabled to respect context timeouts and deadlines 2022-10-11 10:22:42 +03: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 feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +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: always retry write timeouts 2022-10-06 10:06:02 +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 feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
cluster_commands.go feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
cluster_test.go feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
command.go feat: support eval_ro and evalsha_ro 2022-09-24 11:38:04 +08:00
command_test.go chore: v9 2022-06-04 17:42:06 +03:00
commands.go chore: remove outdated comment 2022-10-09 13:11:02 +03:00
commands_test.go chore: remove outdated comment 2022-10-09 13:11:02 +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 feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
example_test.go feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
export_test.go chore: cleanup 2022-08-17 13:18:58 +03:00
go.mod chore(deps): bump github.com/onsi/gomega from 1.20.2 to 1.21.1 2022-10-11 06:41:12 +00:00
go.sum chore(deps): bump github.com/onsi/gomega from 1.20.2 to 1.21.1 2022-10-11 06:41:12 +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 feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
options.go feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
options_test.go Add ParseURL function for cluster mode (#1924) 2022-10-06 13:33:37 +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 feat: add ContextTimeoutEnabled to respect context timeouts and deadlines 2022-10-11 10:22:42 +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 feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
redis_test.go feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
result.go chore: fix some command names 2022-08-08 10:28:46 +03:00
ring.go feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
ring_test.go feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
script.go feat: support eval_ro and evalsha_ro 2022-09-24 11:38:04 +08:00
sentinel.go feat: add OpenTelemetry metrics instrumentation 2022-10-12 11:09:41 +03:00
sentinel_test.go chore: v9 2022-06-04 17:42:06 +03: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 ContextTimeoutEnabled to respect context timeouts and deadlines 2022-10-11 10:22:42 +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 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. Star it as well!

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!