Type-safe Redis client for Golang
Go to file
filipe oliveira cf6cf7f450 Add AuthACL 2020-05-21 08:59:51 +03:00
internal code fmt 2020-04-30 17:46:50 +08:00
testdata Added backoff retry 2017-05-26 14:33:34 +03:00
.gitignore Use go standard path for test data 2016-03-12 10:25:59 +00:00
.golangci.yml Bump golangci-lint to v1.21.0 2019-11-18 18:46:13 +01:00
.travis.yml Remove deprecated sudo setting. 2020-05-12 23:10:04 +08:00
CHANGELOG.md Update changelog 2020-02-22 11:02:03 +02:00
LICENSE Fix license. 2016-09-12 12:00:28 +00:00
Makefile Update build 2019-12-18 12:51:52 +02:00
README.md update README.md 2020-04-12 17:27:32 +08:00
bench_test.go Include multi & exec in pipeline hook 2020-02-14 15:55:16 +02:00
cluster.go Add AuthACL 2020-05-21 08:59:51 +03:00
cluster_commands.go Exported the setErr function as public 2020-02-03 17:53:47 +08:00
cluster_test.go Include multi & exec in pipeline hook 2020-02-14 15:55:16 +02:00
command.go Add test for ring and cluster hooks 2020-02-14 14:30:40 +02:00
command_test.go Add test case for command set error 2020-02-03 18:18:37 +08:00
commands.go Add AuthACL 2020-05-21 08:59:51 +03:00
commands_test.go Fix tests on 32bit arches 2020-03-10 15:41:45 +02:00
doc.go doc: fix outdated reference. 2014-10-07 09:27:55 +03:00
error.go Use semantic import versioning 2019-08-08 14:29:44 +03:00
example_instrumentation_test.go Add missing Tx instrumentation 2019-12-29 12:14:02 +02:00
example_test.go Add test for ring and cluster hooks 2020-02-14 14:30:40 +02:00
export_test.go Use semantic import versioning 2019-08-08 14:29:44 +03:00
go.mod Add missing Tx instrumentation 2019-12-29 12:14:02 +02:00
go.sum Add missing Tx instrumentation 2019-12-29 12:14:02 +02:00
internal_test.go Add missing options to UniversalOptions 2018-08-15 08:44:06 +03:00
iterator.go Cleanup 2019-08-24 11:55:13 +03:00
iterator_test.go Use semantic import versioning 2019-08-08 14:29:44 +03:00
main_test.go Add test for ring and cluster hooks 2020-02-14 14:30:40 +02:00
options.go Add AuthACL 2020-05-21 08:59:51 +03:00
options_test.go Add AuthACL 2020-05-21 08:59:51 +03:00
pipeline.go Use semantic import versioning 2019-08-08 14:29:44 +03:00
pipeline_test.go Use semantic import versioning 2019-08-08 14:29:44 +03:00
pool_test.go Use semantic import versioning 2019-08-08 14:29:44 +03:00
pubsub.go Fix "redis: discarding bad PubSub connection" stuck state (#1162) 2019-09-30 11:24:53 +03:00
pubsub_test.go Use semantic import versioning 2019-08-08 14:29:44 +03:00
race_test.go Include multi & exec in pipeline hook 2020-02-14 15:55:16 +02:00
redis.go Add AuthACL 2020-05-21 08:59:51 +03:00
redis_test.go Add WithTimeout 2020-02-02 14:59:27 +02:00
result.go add NewTimeCmdResult to allow unit testing with TimeCmd (#1298) 2020-04-18 09:05:16 +03:00
ring.go Add client instantiation callback to allow more flexible configuration (#1281) 2020-03-27 15:48:18 +02:00
ring_test.go Add client instantiation callback to allow more flexible configuration (#1281) 2020-03-27 15:48:18 +02:00
script.go Add golangci-lint 2019-07-25 14:36:50 +03:00
sentinel.go Add AuthACL 2020-05-21 08:59:51 +03:00
sentinel_test.go Use semantic import versioning 2019-08-08 14:29:44 +03:00
tx.go Include multi & exec in pipeline hook 2020-02-14 15:55:16 +02:00
tx_test.go Change Tx.Pipeline and Tx.TxPipeline meaning 2020-01-12 14:19:21 +02:00
universal.go Add AuthACL 2020-05-21 08:59:51 +03:00
universal_test.go Use semantic import versioning 2019-08-08 14:29:44 +03:00

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

go-redis requires a Go version with Modules support and uses import versioning. So please make sure to initialize a Go module before installing go-redis:

go mod init github.com/my/repo
go get github.com/go-redis/redis/v7

Import:

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

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() {
	client := redis.NewClient(&redis.Options{
		Addr:     "localhost:6379",
		Password: "", // no password set
		DB:       0,  // use default DB
	})
	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{
	Keys: []string{"zset1", "zset2"},
	Weights: []int64{2, 3}
}).Result()

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

// custom command
res, err := client.Do("set", "key", "value").Result()

See also