Type-safe Redis client for Golang
Go to file
Vladimir Mihailenco 22ed1e8f5b Merge pull request #200 from go-redis/fix/pubsub-close-panic
Fix PubSub panic on concurrent Close.
2015-11-27 13:32:58 +02:00
.test Add Redis Cluster support. 2015-03-19 11:19:55 +02:00
internal/consistenthash Embed consistenthash package. 2015-06-03 14:25:52 +03:00
.gitignore Add Redis Cluster support. 2015-03-19 11:19:55 +02:00
.travis.yml travis: test on tip. 2015-11-22 14:24:57 +02:00
LICENSE Add license. Fixes #1. 2012-12-19 13:05:50 +02:00
Makefile makefile: give Redis time to exit. 2015-11-21 13:24:42 +02:00
README.md Poorman SEO. 2015-10-25 13:30:26 +02:00
cluster.go Clarify thread safety. Fixes #166. 2015-09-12 09:36:03 +03:00
cluster_client_test.go Add Client.String method. 2015-05-18 15:14:12 +03:00
cluster_pipeline.go multi: fix recovering from bad connection. 2015-11-14 14:44:16 +02:00
cluster_test.go Fix test. 2015-11-22 17:53:44 +02:00
command.go Fix GeoRadius reply parsing. 2015-11-14 16:36:21 +02:00
command_test.go Allow setting and scaning interface{} values. 2015-07-11 11:54:26 +03:00
commands.go Fix GeoRadius reply parsing. 2015-11-14 16:36:21 +02:00
commands_test.go Fix test. 2015-11-22 17:53:44 +02:00
conn.go Fix pool panic on slow connection with MaxRetries > 0. 2015-10-13 12:10:04 +03:00
conn_test.go Fix pool panic on slow connection with MaxRetries > 0. 2015-10-13 12:10:04 +03:00
crc16.go Add Redis Cluster support. 2015-03-19 11:19:55 +02:00
crc16_test.go Add Redis Cluster support. 2015-03-19 11:19:55 +02:00
doc.go doc: fix outdated reference. 2014-10-07 09:27:55 +03:00
error.go multi: fix recovering from bad connection. 2015-11-14 14:44:16 +02:00
example_test.go Merge pull request #197 from shagabutdinov/docs/blpop-example 2015-11-25 12:23:48 +02:00
export_test.go Fix pool panic on slow connection with MaxRetries > 0. 2015-10-13 12:10:04 +03:00
main_test.go Try to make cluster tests more stable. 2015-11-14 15:55:01 +02:00
multi.go Improve Tx example. 2015-11-15 10:23:47 +02:00
multi_test.go multi: fix recovering from bad connection. 2015-11-14 14:44:16 +02:00
parser.go Fix GeoRadius reply parsing. 2015-11-14 16:36:21 +02:00
parser_test.go Refactor reply parser. 2015-10-07 17:09:20 +03:00
pipeline.go multi: fix recovering from bad connection. 2015-11-14 14:44:16 +02:00
pipeline_test.go Make Pipeline thread-safe. Fixes #166. 2015-11-04 14:25:48 +02:00
pool.go Fix PubSub panic on concurrent Close. 2015-11-26 17:09:09 +02:00
pool_test.go multi: fix recovering from bad connection. 2015-11-14 14:44:16 +02:00
pubsub.go Fix test. 2015-11-22 17:53:44 +02:00
pubsub_test.go Fix PubSub panic on concurrent Close. 2015-11-26 17:09:09 +02:00
redis.go Fix doc comment for PoolTimeout. 2015-11-18 16:35:02 +02:00
redis_test.go multi: fix recovering from bad connection. 2015-11-14 14:44:16 +02:00
ring.go Increase test timeout. 2015-11-21 10:20:01 +02:00
ring_test.go Fix test. 2015-11-22 17:53:44 +02:00
safe.go Don't use unsafe on appengine. Fixes #151. 2015-08-21 11:23:52 +03:00
script.go script: fix small API inconsistency (backwards compatible). 2015-06-11 17:17:06 +03:00
sentinel.go Fix pool panic on slow connection with MaxRetries > 0. 2015-10-13 12:10:04 +03:00
sentinel_test.go Release redis.v3 beta. 2015-05-14 16:24:19 +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()

Shameless plug

Check my PostgreSQL client for Go.