Type-safe Redis client for Golang (evacuated from NSA/Microsoft Github)

Puneeth Gadangi 0269263441 Use cmdSlotAndNode() to route read-only ClusterClient pipeline commands 5 years ago
internal faf5666fbd Cleanup pool 5 years ago
testdata 406e882c43 Added backoff retry 7 years ago
.gitignore e80f790e76 Use go standard path for test data 8 years ago
.travis.yml e9e73a92c0 travis: test on Go 1.10 6 years ago
LICENSE f69688538d Fix license. 7 years ago
Makefile a64d3e1ef1 Fix build on 32bit arch 6 years ago
README.md 58bf6f4abe Add Airbrake badge 6 years ago
bench_test.go 852a60d520 Fix go vet 6 years ago
cluster.go 0269263441 Use cmdSlotAndNode() to route read-only ClusterClient pipeline commands 5 years ago
cluster_commands.go 0a7606651d Add Cluster.DBSize 6 years ago
cluster_test.go 5c742fff78 cluster: cleanup tests 6 years ago
command.go 18b2e30835 Cleanup cmds info 6 years ago
command_test.go f1ed2ad288 Add FlushDBAsync and FlushAllAsync 6 years ago
commands.go 5c742fff78 cluster: cleanup tests 6 years ago
commands_test.go 34facee367 Add more race tests 6 years ago
doc.go 7aeeecb761 doc: fix outdated reference. 9 years ago
example_instrumentation_test.go 852a60d520 Fix go vet 6 years ago
example_test.go bdbad50f7e Fix grammar in ExampleClient 6 years ago
export_test.go 5c742fff78 cluster: cleanup tests 6 years ago
iterator.go 10c56cede3 Remove Scanner in favor of ScanCmd. 7 years ago
iterator_test.go f1ed2ad288 Add FlushDBAsync and FlushAllAsync 6 years ago
main_test.go 11ca0e65c6 Add race test for BLPop 6 years ago
options.go faf5666fbd Cleanup pool 5 years ago
options_test.go ea762c666e removed quotes surrounding %q 6 years ago
parser.go 56dea1f39a Fix proto.RedisError in slices 6 years ago
pipeline.go f9307ab2fe Add TxPipeline to Cmdable 6 years ago
pipeline_test.go f1ed2ad288 Add FlushDBAsync and FlushAllAsync 6 years ago
pool_test.go faf5666fbd Cleanup pool 5 years ago
pubsub.go 877867d284 Remove costly 'appendIfNotExists' and 'remove' call from PubSub (#743) 6 years ago
pubsub_test.go 742a58164c Add test for receive big message payload 6 years ago
race_test.go 34facee367 Add more race tests 6 years ago
redis.go faf5666fbd Cleanup pool 5 years ago
redis_test.go faf5666fbd Cleanup pool 5 years ago
result.go 9ccc23344a Update result.go (#754) 6 years ago
ring.go faf5666fbd Cleanup pool 5 years ago
ring_test.go f1ed2ad288 Add FlushDBAsync and FlushAllAsync 6 years ago
script.go 7acec74c59 Script: Fix `Exists` to use hash instead of source (#726) 6 years ago
sentinel.go 39b4d69170 Export SentinelClient 5 years ago
sentinel_test.go fbc8000fd1 Resent client pool when sentinel switches master 6 years ago
tx.go 56dea1f39a Fix proto.RedisError in slices 6 years ago
tx_test.go faf5666fbd Cleanup pool 5 years ago
universal.go 09b9a99666 Add TLS configuration support for Universal Client 6 years ago
universal_test.go 271ccda187 Update import 7 years ago

README.md

Redis client for Golang

Build Status GoDoc Airbrake

Supports:

API docs: https://godoc.org/github.com/go-redis/redis. Examples: https://godoc.org/github.com/go-redis/redis#pkg-examples.

Installation

Install:

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

Import:

import "github.com/go-redis/redis"

Quickstart

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

	pong, err := client.Ping().Result()
	fmt.Println(pong, err)
	// Output: PONG <nil>
}

func ExampleClient() {
	err := client.Set("key", "value", 0).Err()
	if err != nil {
		panic(err)
	}

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

	val2, err := client.Get("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
}

Howto

Please go through examples to get an idea how to use this package.

Look and feel

Some corner cases:

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

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

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

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

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

Benchmark

go-redis vs redigo:

BenchmarkSetGoRedis10Conns64Bytes-4 	  200000	      7621 ns/op	     210 B/op	       6 allocs/op
BenchmarkSetGoRedis100Conns64Bytes-4	  200000	      7554 ns/op	     210 B/op	       6 allocs/op
BenchmarkSetGoRedis10Conns1KB-4     	  200000	      7697 ns/op	     210 B/op	       6 allocs/op
BenchmarkSetGoRedis100Conns1KB-4    	  200000	      7688 ns/op	     210 B/op	       6 allocs/op
BenchmarkSetGoRedis10Conns10KB-4    	  200000	      9214 ns/op	     210 B/op	       6 allocs/op
BenchmarkSetGoRedis100Conns10KB-4   	  200000	      9181 ns/op	     210 B/op	       6 allocs/op
BenchmarkSetGoRedis10Conns1MB-4     	    2000	    583242 ns/op	    2337 B/op	       6 allocs/op
BenchmarkSetGoRedis100Conns1MB-4    	    2000	    583089 ns/op	    2338 B/op	       6 allocs/op
BenchmarkSetRedigo10Conns64Bytes-4  	  200000	      7576 ns/op	     208 B/op	       7 allocs/op
BenchmarkSetRedigo100Conns64Bytes-4 	  200000	      7782 ns/op	     208 B/op	       7 allocs/op
BenchmarkSetRedigo10Conns1KB-4      	  200000	      7958 ns/op	     208 B/op	       7 allocs/op
BenchmarkSetRedigo100Conns1KB-4     	  200000	      7725 ns/op	     208 B/op	       7 allocs/op
BenchmarkSetRedigo10Conns10KB-4     	  100000	     18442 ns/op	     208 B/op	       7 allocs/op
BenchmarkSetRedigo100Conns10KB-4    	  100000	     18818 ns/op	     208 B/op	       7 allocs/op
BenchmarkSetRedigo10Conns1MB-4      	    2000	    668829 ns/op	     226 B/op	       7 allocs/op
BenchmarkSetRedigo100Conns1MB-4     	    2000	    679542 ns/op	     226 B/op	       7 allocs/op

Redis Cluster:

BenchmarkRedisPing-4                	  200000	      6983 ns/op	     116 B/op	       4 allocs/op
BenchmarkRedisClusterPing-4         	  100000	     11535 ns/op	     117 B/op	       4 allocs/op

See also