summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/readonly.md
blob: 00e8aadeb5728b09f1560e9612e85dfc186c8526 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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