Type-safe Redis client for Golang
Go to file
Vladimir Mihailenco a972489416 Merge pull request #120 from go-redis/feature/ring-pipeline
Add RingPipeline.
2015-06-04 12:12:24 +03: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 Embed consistenthash package. 2015-06-03 14:25:52 +03:00
LICENSE Add license. Fixes #1. 2012-12-19 13:05:50 +02:00
Makefile makefile: remove ginkgo flags. 2015-06-03 14:25:52 +03:00
README.md Update readme for v3. 2015-05-23 14:43:49 +03:00
cluster.go Add Redis Ring. 2015-06-03 14:25:52 +03:00
cluster_client_test.go Add Client.String method. 2015-05-18 15:14:12 +03:00
cluster_pipeline.go Add RingPipeline. 2015-06-04 11:50:24 +03:00
cluster_test.go Fix flaky test. 2015-06-03 17:08:27 +03:00
command.go Add auto-retry and MaxRetries option. Fixes #84. 2015-05-10 17:02:47 +03:00
command_test.go Release redis.v3 beta. 2015-05-14 16:24:19 +03:00
commands.go Add ClientPause command. 2015-05-15 15:11:22 +03:00
commands_test.go Fix flaky tests by using better matcher. 2015-06-03 15:09:56 +03:00
conn.go Reduce number of various options structs. Slightly reword comments. 2015-05-23 17:56:18 +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 Update readme for v3. 2015-05-23 14:43:49 +03:00
example_test.go Add basic example how to use Redis Cluster. Unify comments. 2015-05-23 16:35:30 +03:00
export_test.go Add auto-retry and MaxRetries option. Fixes #84. 2015-05-10 17:02:47 +03:00
main_test.go pool: put connection to the list before returning it. 2015-06-03 16:45:46 +03:00
multi.go pool: put connection to the list before returning it. 2015-06-03 16:45:46 +03:00
multi_test.go Release redis.v3 beta. 2015-05-14 16:24:19 +03:00
parser.go Add Redis Cluster support. 2015-03-19 11:19:55 +02:00
parser_test.go More benchmarks. 2014-07-04 15:19:45 +03:00
pipeline.go Add RingPipeline. 2015-06-04 11:50:24 +03:00
pipeline_test.go Release redis.v3 beta. 2015-05-14 16:24:19 +03:00
pool.go pool: put connection to the list before returning it. 2015-06-03 16:45:46 +03:00
pool_test.go Fix flaky test. 2015-06-03 14:36:48 +03:00
pubsub.go More comments. 2015-05-23 18:17:45 +03:00
pubsub_test.go Release redis.v3 beta. 2015-05-14 16:24:19 +03:00
redis.go Reduce number of various options structs. Slightly reword comments. 2015-05-23 17:56:18 +03:00
redis_test.go pool: put connection to the list before returning it. 2015-06-03 16:45:46 +03:00
ring.go Add RingPipeline. 2015-06-04 11:50:24 +03:00
ring_test.go Add RingPipeline. 2015-06-04 11:50:24 +03:00
script.go all: switch to gopkg.in. 2014-05-11 10:44:22 +03:00
sentinel.go Reduce number of various options structs. Slightly reword comments. 2015-05-23 17:56:18 +03:00
sentinel_test.go Release redis.v3 beta. 2015-05-14 16:24:19 +03:00

README.md

Redis client for Golang Build Status

Supports:

  • Redis 3 commands except QUIT, MONITOR, SLOWLOG and SYNC.
  • Pub/Sub.
  • Transactions.
  • Pipelines.
  • Connection pool. Client can be safely used from multiple goroutines.
  • Timeouts.
  • Redis Sentinel.
  • Redis Cluster.

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()