Package redisc implements a redis cluster client built on top of the redigo package. See the documentation for details.
$ go get [-u] [-t] github.com/famagusta/redisc
-
v1.2.0 : Use Go modules, fix a failing test due to changed error message on Redis 6.
-
v1.1.7 : Do not bind to a random node if
Do
is called without a command and the connection is not already bound (thanks to @tysonmote). -
v1.1.6 : Append the actual error messages when a refresh returns "all nodes failed" error.
-
v1.1.5 : Add
Cluster.PoolWaitTime
to configure the time to wait on a connection from a pool withMaxActive
> 0 andWait
set to true (thanks to @iwanbk). -
v1.1.4 : Add
Conn.DoWithTimeout
andConn.ReceiveWithTimeout
to match redigo'sConnWithTimeout
interface (thanks to @letsfire). -
v1.1.3 : Fix handling of
ASK
replies inRetryConn
. -
v1.1.2 : Remove mention that
StartupNodes
inCluster
struct needs to be master nodes (it can be replicas). Add supporting test. -
v1.1.1 : Fix CI tests.
-
v1.1.0 : This release builds with the
github.com/gomodule/redigo
package (the new import path ofredigo
, which also has a breaking change in itsv2.0.0
, thePMessage
type has been removed and consolidated intoMessage
). -
v1.0.0 : This release builds with the
github.com/garyburd/redigo
package, which - according to its readme - will not be maintained anymore, having moved togithub.com/gomodule/redigo
for future development. As such,redisc
will not be updated with the old redigo package, this version was created only to avoid causing issues to users of redisc.
The code documentation is the canonical source for documentation.
The design goal of redisc is to be as compatible as possible with the redigo package. As such, the Cluster
type can be used as a drop-in replacement to a redis.Pool
, and the connections returned by the cluster implement the redis.Conn
interface. The package offers additional features specific to dealing with a cluster that may be needed for more advanced scenarios.
The main features are:
- Drop-in replacement for
redis.Pool
(theCluster
type implements the sameGet
andClose
method signatures). - Connections are
redis.Conn
interfaces and use theredigo
package to execute commands,redisc
only handles the cluster part. - Support for all cluster-supported commands including scripting, transactions and pub-sub.
- Support for READONLY/READWRITE commands to allow reading data from replicas.
- Client-side smart routing, automatically keeps track of which node holds which key slots.
- Automatic retry of MOVED, ASK and TRYAGAIN errors when desired, via
RetryConn
. - Manual handling of redirections and retries when desired, via
IsTryAgain
andParseRedir
. - Automatic detection of the node to call based on the command's first parameter (assumed to be the key).
- Explicit selection of the node to call via
BindConn
when needed. - Support for optimal batch calls via
SplitBySlot
.
- redis-go-cluster.
- radix v1 provides a cluster package.
- radix v2 provides a cluster package.
There are a number of ways you can support the project:
- Use it, star it, build something with it, spread the word!
- Raise issues to improve the project (note: doc typos and clarifications are issues too!)
- Please search existing issues before opening a new one - it may have already been adressed.
- Pull requests: please discuss new code in an issue first, unless the fix is really trivial.
- Make sure new code is tested.
- Be mindful of existing code - PRs that break existing code have a high probability of being declined, unless it fixes a serious issue.
- Sponsor the developer
- See the Github Sponsor button at the top of the repo on github
- or via BuyMeACoffee.com, below
The BSD 3-Clause license.