Sign inDemoInstall

Package Overview
File Explorer

Install Socket

Protect your apps from supply chain attacks



Version published


# redis-go-cluster
redis-go-cluster is a golang implementation of redis client based on Gary Burd's

* Most commands of keys, strings, lists, sets, sorted sets, hashes.
* Pipelining

**NOT supported**:
* Cluster commands
* Pub/Sub
* Transaction
* Lua script

## Installation
Install redis-go-cluster with go tool:
    go get
## Usage
To use redis cluster, you need import the package and create a new cluster client
with an options:
import ""

cluster, err := redis.NewCluster(
	StartNodes: []string{"", "", ""},
	ConnTimeout: 50 * time.Millisecond,
	ReadTimeout: 50 * time.Millisecond,
	WriteTimeout: 50 * time.Millisecond,
	KeepAlive: 16,
	AliveTime: 60 * time.Second,

### Basic
redis-go-cluster has compatible interface to [Redigo](, 
which uses a print-like API for all redis commands. When executing a command, it need a key 
to hash to a slot, then find the corresponding redis node. Do method will choose first
argument in args as the key, so commands which are independent from keys are not supported,
such as SYNC, BGSAVE, RANDOMKEY, etc. 

**RESTRICTION**: Please be sure the first argument in args is key.

See full redis commands:

cluster.Do("SET", "foo", "bar")
cluster.Do("INCR", "mycount", 1)
cluster.Do("LPUSH", "mylist", "foo", "bar")
cluster.Do("HMSET", "myhash", "f1", "foo", "f2", "bar")
You can use help functions to convert reply to int, float, string, etc.
reply, err := Int(cluster.Do("INCR", "mycount", 1))
reply, err := String(cluster.Do("GET", "foo"))
reply, err := Strings(cluster.Do("LRANGE", "mylist", 0, -1))
reply, err := StringMap(cluster.Do("HGETALL", "myhash"))
Also, you can use Values and Scan to convert replies to multiple values with different types.
_, err := cluster.Do("MSET", "key1", "foo", "key2", 1024, "key3", 3.14, "key4", "false")
reply, err := Values(cluster.Do("MGET", "key1", "key2", "key3", "key4"))
var val1 string
var val2 int
reply, err = Scan(reply, &val1, &val2)
var val3 float64
reply, err = Scan(reply, &val3)
var val4 bool
reply, err = Scan(reply, &val4)


### Multi-keys
Mutiple keys command - MGET/MSET are supported using result aggregation.
Processing steps are as follows:
- First, split the keys into multiple nodes according to their hash slot.
- Then, start a goroutine for each node to excute MGET/MSET commands and wait them finish.
- Last, collect and rerange all replies, return back to caller.

**NOTE**: Since the keys may spread across mutiple node, there's no atomicity gurantee that 
all keys will be set at once. It's possible that some keys are set while others are not.

### Pipelining
Pipelining is supported through the Batch interface. You can put multiple commands into a 
batch as long as it is supported by Do method. RunBatch will split these command to distinct
nodes and start a goroutine for each node. Commands hash to same nodes will be merged and sent 
using pipelining. After all commands done, it rearrange results as MGET/MSET do. Result is a 
slice of each command's reply, you can use Scan to convert them to other types.
batch := cluster.NewBatch()
err = batch.Put("LPUSH", "country_list", "France")
err = batch.Put("LPUSH", "country_list", "Italy")
err = batch.Put("LPUSH", "country_list", "Germany")
err = batch.Put("INCRBY", "countries", 3)
err = batch.Put("LRANGE", "country_list", 0, -1)
reply, err = cluster.RunBatch(batch)

var resp int
for i := 0; i < 4; i++ {
    reply, err = redis.Scan(reply, &resp)    

countries, err := Strings(reply[0], nil)

## Contact
Bug reports and feature requests are welcome.
If you have any question, please email me

## License
redis-go-cluster is available under the [Apache License, Version 2.0](


Last updated on 26 Nov 2015

Did you know?

Socket installs a GitHub app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.


Related posts

SocketSocket SOC 2 Logo


  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc