redis/README.md

140 lines
4.5 KiB
Markdown
Raw Normal View History

2017-06-17 13:01:40 +03:00
# Redis client for Golang
[![Build Status](https://travis-ci.org/go-redis/redis.png?branch=master)](https://travis-ci.org/go-redis/redis)
2020-05-09 17:38:45 +03:00
[![GoDoc](https://godoc.org/github.com/go-redis/redis?status.svg)](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc)
2013-10-15 14:51:40 +04:00
2020-06-09 17:59:23 +03:00
## Sponsors
- [**Uptrace.dev** - distributed traces and metrics](https://uptrace.dev)
## Ecosystem
- [Redis Cache](https://github.com/go-redis/cache).
- [Rate limiting](https://github.com/go-redis/redis_rate).
- [Distributed Locks](https://github.com/bsm/redislock).
## Features
2014-05-11 11:42:40 +04:00
2015-05-23 14:33:33 +03:00
- Redis 3 commands except QUIT, MONITOR, SLOWLOG and SYNC.
2020-06-09 17:59:23 +03:00
- Automatic connection pooling with
[circuit breaker](https://en.wikipedia.org/wiki/Circuit_breaker_design_pattern) support.
2020-05-09 17:38:45 +03:00
- [Pub/Sub](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#PubSub).
- [Transactions](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#example-Client-TxPipeline).
2020-06-09 17:59:23 +03:00
- [Pipeline](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#example-Client-Pipeline) and
[TxPipeline](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#example-Client-TxPipeline).
2020-05-09 17:38:45 +03:00
- [Scripting](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#Script).
- [Timeouts](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#Options).
- [Redis Sentinel](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#NewFailoverClient).
- [Redis Cluster](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#NewClusterClient).
2020-06-09 17:59:23 +03:00
- [Cluster of Redis Servers](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#example-NewClusterClient--ManualSetup)
without using cluster mode and Redis Sentinel.
2020-05-09 17:38:45 +03:00
- [Ring](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#NewRing).
- [Instrumentation](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#ex-package--Instrumentation).
2014-05-11 11:42:40 +04:00
2020-06-09 17:59:23 +03:00
API docs: https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc. Examples:
https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#pkg-examples.
2014-05-11 11:42:40 +04:00
2015-10-25 14:30:26 +03:00
## Installation
2014-05-11 11:42:40 +04:00
2020-06-09 17:59:23 +03:00
go-redis requires a Go version with [Modules](https://github.com/golang/go/wiki/Modules) support and
uses import versioning. So please make sure to initialize a Go module before installing go-redis:
2014-05-11 11:42:40 +04:00
2020-05-09 17:38:45 +03:00
```shell
2019-12-09 10:54:23 +03:00
go mod init github.com/my/repo
2020-05-09 17:38:45 +03:00
go get github.com/go-redis/redis/v8
2016-10-12 15:11:09 +03:00
```
Import:
2020-05-09 17:38:45 +03:00
```go
import "github.com/go-redis/redis/v8"
2016-10-12 15:11:09 +03:00
```
2015-10-25 14:30:26 +03:00
## Quickstart
2015-05-23 14:33:33 +03:00
2020-05-09 17:38:45 +03:00
```go
2015-05-23 14:33:33 +03:00
func ExampleNewClient() {
2020-05-26 12:07:28 +03:00
client := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
Password: "", // no password set
DB: 0, // use default DB
})
pong, err := client.Ping(ctx).Result()
fmt.Println(pong, err)
// Output: PONG <nil>
2015-05-23 14:33:33 +03:00
}
func ExampleClient() {
2020-05-26 12:07:28 +03:00
client := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
Password: "", // no password set
DB: 0, // use default DB
})
err := client.Set(ctx, "key", "value", 0).Err()
if err != nil {
panic(err)
}
val, err := client.Get(ctx, "key").Result()
if err != nil {
panic(err)
}
fmt.Println("key", val)
val2, err := client.Get(ctx, "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
2015-05-23 14:33:33 +03:00
}
```
2015-10-25 14:30:26 +03:00
## Howto
2015-05-23 14:33:33 +03:00
2020-06-09 17:59:23 +03:00
Please go through [examples](https://pkg.go.dev/github.com/go-redis/redis/v8?tab=doc#pkg-examples)
to get an idea how to use this package.
2014-05-11 11:42:40 +04:00
2015-10-25 14:30:26 +03:00
## Look and feel
2014-05-11 11:42:40 +04:00
Some corner cases:
2020-05-09 17:38:45 +03:00
```go
2018-07-20 11:47:53 +03:00
// SET key value EX 10 NX
2020-05-26 12:07:28 +03:00
set, err := client.SetNX(ctx, "key", "value", 10*time.Second).Result()
2015-05-23 14:33:33 +03:00
2018-07-20 11:47:53 +03:00
// SORT list LIMIT 0 2 ASC
2020-05-26 12:07:28 +03:00
vals, err := client.Sort(ctx, "list", &redis.Sort{Offset: 0, Count: 2, Order: "ASC"}).Result()
2014-05-11 11:42:40 +04:00
2018-07-20 11:47:53 +03:00
// ZRANGEBYSCORE zset -inf +inf WITHSCORES LIMIT 0 2
2020-05-26 12:07:28 +03:00
vals, err := client.ZRangeByScoreWithScores(ctx, "zset", &redis.ZRangeBy{
Min: "-inf",
Max: "+inf",
Offset: 0,
Count: 2,
2018-07-20 11:47:53 +03:00
}).Result()
2014-05-11 11:42:40 +04:00
2018-07-20 11:47:53 +03:00
// ZINTERSTORE out 2 zset1 zset2 WEIGHTS 2 3 AGGREGATE SUM
2020-05-26 12:07:28 +03:00
vals, err := client.ZInterStore(ctx, "out", &redis.ZStore{
Keys: []string{"zset1", "zset2"},
Weights: []int64{2, 3}
2020-04-12 12:27:32 +03:00
}).Result()
2014-05-11 11:42:40 +04:00
2018-07-20 11:47:53 +03:00
// EVAL "return {KEYS[1],ARGV[1]}" 1 "key" "hello"
2020-05-26 12:07:28 +03:00
vals, err := client.Eval(ctx, "return {KEYS[1],ARGV[1]}", []string{"key"}, "hello").Result()
2016-03-19 17:55:22 +03:00
2019-06-04 13:32:54 +03:00
// custom command
2020-05-26 12:07:28 +03:00
res, err := client.Do(ctx, "set", "key", "value").Result()
2016-03-10 12:10:47 +03:00
```
2017-04-05 15:32:37 +03:00
## See also
2015-10-25 14:30:26 +03:00
2017-04-05 15:32:37 +03:00
- [Golang PostgreSQL ORM](https://github.com/go-pg/pg)
- [Golang msgpack](https://github.com/vmihailenco/msgpack)
2019-04-22 16:57:58 +03:00
- [Golang message task queue](https://github.com/vmihailenco/taskq)