Type-safe Redis client for Golang
Go to file
Vladimir Mihailenco 46cb31d37d Merge pull request from go-redis/feature/tweak-tx-api
Tweak transaction API.
2016-05-03 09:22:27 +03:00
internal Move logger to internal package. 2016-04-09 14:52:01 +03:00
testdata Use go standard path for test data 2016-03-12 10:25:59 +00:00
.gitignore Use go standard path for test data 2016-03-12 10:25:59 +00:00
.travis.yml Use redis.v4 that is in alpha/beta state. 2016-04-09 13:27:16 +03:00
LICENSE Remove Go 1.4 from test build. Bump license. 2016-03-19 15:45:28 +02:00
Makefile Extract race tests to separate file. Add more race tests. 2016-03-16 19:45:35 +02:00
README.md Add redis cluster benchmark results. 2016-03-19 16:55:47 +02:00
bench_test.go Use redis.v4 that is in alpha/beta state. 2016-04-09 13:27:16 +03:00
cluster.go Tweak transaction API. 2016-05-02 15:54:15 +03:00
cluster_client_test.go Expose cluster node id in ClusterSlots. 2016-04-09 12:52:43 +03:00
cluster_test.go Tweak transaction API. 2016-05-02 15:54:15 +03:00
command.go Scan: swap return values and change cursor type. 2016-04-26 16:08:31 +03:00
command_test.go Convert bytes to string in Cmd. 2016-04-12 19:41:56 +03:00
commands.go Scan: swap return values and change cursor type. 2016-04-26 16:08:31 +03:00
commands_test.go Scan: swap return values and change cursor type. 2016-04-26 16:08:31 +03:00
doc.go doc: fix outdated reference. 2014-10-07 09:27:55 +03:00
error.go Cleanup error handling code. 2016-03-19 16:33:14 +02:00
example_test.go Tweak transaction API. 2016-05-02 15:54:15 +03:00
export_test.go Move logger to internal package. 2016-04-09 14:52:01 +03:00
iterator.go Add scan iterator. 2016-04-26 15:01:49 +03:00
iterator_test.go Add scan iterator. 2016-04-26 15:01:49 +03:00
main_test.go Use redis.v4 that is in alpha/beta state. 2016-04-09 13:27:16 +03:00
options.go Use redis.v4 that is in alpha/beta state. 2016-04-09 13:27:16 +03:00
parser.go Scan: swap return values and change cursor type. 2016-04-26 16:08:31 +03:00
parser_test.go Use redis.v4 that is in alpha/beta state. 2016-04-09 13:27:16 +03:00
pipeline.go Use redis.v4 that is in alpha/beta state. 2016-04-09 13:27:16 +03:00
pipeline_test.go Use redis.v4 that is in alpha/beta state. 2016-04-09 13:27:16 +03:00
pool_test.go Tweak transaction API. 2016-05-02 15:54:15 +03:00
pubsub.go Move logger to internal package. 2016-04-09 14:52:01 +03:00
pubsub_test.go Move logger to internal package. 2016-04-09 14:52:01 +03:00
race_test.go Tweak transaction API. 2016-05-02 15:54:15 +03:00
redis.go Add scan iterator. 2016-04-26 15:01:49 +03:00
redis_test.go Tweak transaction API. 2016-05-02 15:54:15 +03:00
ring.go Move logger to internal package. 2016-04-09 14:52:01 +03:00
ring_test.go Use redis.v4 that is in alpha/beta state. 2016-04-09 13:27:16 +03:00
safe.go Don't use unsafe on appengine. Fixes . 2015-08-21 11:23:52 +03:00
script.go Accept interface{} in Eval. Fixes . 2016-04-09 11:01:33 +03:00
sentinel.go Move logger to internal package. 2016-04-09 14:52:01 +03:00
sentinel_test.go Use redis.v4 that is in alpha/beta state. 2016-04-09 13:27:16 +03:00
tx.go Tweak transaction API. 2016-05-02 15:54:15 +03:00
tx_test.go Tweak transaction API. 2016-05-02 15:54:15 +03:00
unsafe.go Enable unsafe. 2015-09-04 13:30:37 +03:00

README.md

Redis client for Golang Build Status

Supports:

API docs: http://godoc.org/gopkg.in/redis.v3. Examples: http://godoc.org/gopkg.in/redis.v3#pkg-examples.

Installation

Install:

go get gopkg.in/redis.v3

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 exists")
	} else if err != nil {
		panic(err)
	} else {
		fmt.Println("key2", val2)
	}
	// Output: key value
	// key2 does not exists
}

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.ZRangeByScore{
    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"}, []string{"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

Shameless plug

Check my PostgreSQL client for Go.