Type-safe Redis client for Golang
Go to file
Vladimir Mihailenco 084336d5eb Merge pull request from go-redis/fix/time-cmd
Fix/time cmd
2016-10-14 14:50:30 +03:00
internal internal/proto: use read prefix to indicate that method reads from the stream. 2016-10-14 14:46:35 +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 Prepare v5 release. 2016-10-09 10:56:53 +00:00
CHANGELOG.md Update changelog. 2016-10-14 14:21:25 +03:00
LICENSE Fix license. 2016-09-12 12:00:28 +00:00
Makefile Extract race tests to separate file. Add more race tests. 2016-03-16 19:45:35 +02:00
README.md Remove static import 2016-10-12 13:11:09 +01:00
bench_test.go Prepare v5 release. 2016-10-09 10:56:53 +00:00
cluster.go Retry multiple commands more conservatively. 2016-10-13 13:56:24 +03:00
cluster_client_test.go Remove Addr field from clusterNode 2016-10-06 05:24:28 +09:00
cluster_test.go Refactor Tx using Pipeline to implement Cmdable interface. 2016-10-13 14:36:15 +03:00
command.go Add TimeCmd. 2016-10-14 14:39:02 +03:00
command_test.go Prepare v5 release. 2016-10-09 10:56:53 +00:00
commands.go Add TimeCmd. 2016-10-14 14:39:02 +03:00
commands_test.go Add TimeCmd. 2016-10-14 14:39:02 +03:00
doc.go doc: fix outdated reference. 2014-10-07 09:27:55 +03:00
example_test.go Refactor Tx using Pipeline to implement Cmdable interface. 2016-10-13 14:36:15 +03:00
export_test.go Prepare v5 release. 2016-10-09 10:56:53 +00:00
iterator.go fix comments 2016-09-08 16:40:45 +03:00
iterator_test.go Prepare v5 release. 2016-10-09 10:56:53 +00:00
main_test.go Prepare v5 release. 2016-10-09 10:56:53 +00:00
options.go Prepare v5 release. 2016-10-09 10:56:53 +00:00
parser.go internal/proto: use read prefix to indicate that method reads from the stream. 2016-10-14 14:46:35 +03:00
pipeline.go Merge pull request from go-redis/fix/retry-multi-cmds-conservatively 2016-10-13 14:05:44 +03:00
pipeline_test.go Prepare v5 release. 2016-10-09 10:56:53 +00:00
pool_test.go Refactor Tx using Pipeline to implement Cmdable interface. 2016-10-13 14:36:15 +03:00
pubsub.go Remove internal errors package that clashes with std lib. 2016-10-09 11:44:31 +00:00
pubsub_test.go Prepare v5 release. 2016-10-09 10:56:53 +00:00
race_test.go Refactor Tx using Pipeline to implement Cmdable interface. 2016-10-13 14:36:15 +03:00
redis.go Retry multiple commands more conservatively. 2016-10-13 13:56:24 +03:00
redis_test.go Refactor Tx using Pipeline to implement Cmdable interface. 2016-10-13 14:36:15 +03:00
result.go Add Cmd constructors for testing/mock purposes. 2016-08-22 21:20:49 +01:00
ring.go Retry multiple commands more conservatively. 2016-10-13 13:56:24 +03:00
ring_test.go More cluster tests. 2016-10-09 11:27:38 +00:00
script.go Accept interface{} in Eval. Fixes . 2016-04-09 11:01:33 +03:00
sentinel.go Prepare v5 release. 2016-10-09 10:56:53 +00:00
sentinel_test.go Prepare v5 release. 2016-10-09 10:56:53 +00:00
tx.go Refactor Tx using Pipeline to implement Cmdable interface. 2016-10-13 14:36:15 +03:00
tx_test.go Refactor Tx using Pipeline to implement Cmdable interface. 2016-10-13 14:36:15 +03:00

README.md

Redis client for Golang Build Status

Supports:

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

Installation

Install:

go get gopkg.in/redis.v5

Import:

import "gopkg.in/redis.v5"

Vendoring

If you are using a vendoring tool with support for semantic versioning e.g. glide, you can import this package via its GitHub URL:

- package: github.com/go-redis/redis
  version: ^5.0.0

WARNING: please note that by importing github.com/go-redis/redis directly (without semantic versioning constrol) you are in danger of running in the breaking API changes. Use carefully and at your own risk!

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.