diff options
Diffstat (limited to 'iredis/data/commands/readonly.md')
-rw-r--r-- | iredis/data/commands/readonly.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/iredis/data/commands/readonly.md b/iredis/data/commands/readonly.md new file mode 100644 index 0000000..00e8aad --- /dev/null +++ b/iredis/data/commands/readonly.md @@ -0,0 +1,21 @@ +Enables read queries for a connection to a Redis Cluster replica node. + +Normally replica nodes will redirect clients to the authoritative master for the +hash slot involved in a given command, however clients can use replicas in order +to scale reads using the `READONLY` command. + +`READONLY` tells a Redis Cluster replica node that the client is willing to read +possibly stale data and is not interested in running write queries. + +When the connection is in readonly mode, the cluster will send a redirection to +the client only if the operation involves keys not served by the replica's +master node. This may happen because: + +1. The client sent a command about hash slots never served by the master of this + replica. +2. The cluster was reconfigured (for example resharded) and the replica is no + longer able to serve commands for a given hash slot. + +@return + +@simple-string-reply |