diff options
Diffstat (limited to 'iredis/data/commands/role.md')
| -rw-r--r-- | iredis/data/commands/role.md | 49 |
1 files changed, 13 insertions, 36 deletions
diff --git a/iredis/data/commands/role.md b/iredis/data/commands/role.md index c42fa74..c308c93 100644 --- a/iredis/data/commands/role.md +++ b/iredis/data/commands/role.md @@ -1,17 +1,13 @@ -Provide information on the role of a Redis instance in the context of -replication, by returning if the instance is currently a `master`, `slave`, or -`sentinel`. The command also returns additional information about the state of -the replication (if the role is master or slave) or the list of monitored master -names (if the role is sentinel). +Provide information on the role of a Redis instance in the context of replication, by returning if the instance is currently a `master`, `slave`, or `sentinel`. The command also returns additional information about the state of the replication (if the role is master or slave) or the list of monitored master names (if the role is sentinel). ## Output format -The command returns an array of elements. The first element is the role of the -instance, as one of the following three strings: +The command returns an array of elements. The first element is the role of +the instance, as one of the following three strings: -- "master" -- "slave" -- "sentinel" +* "master" +* "slave" +* "sentinel" The additional elements of the array depends on the role. @@ -33,12 +29,8 @@ An example of output when `ROLE` is called in a master instance: The master output is composed of the following parts: 1. The string `master`. -2. The current master replication offset, which is an offset that masters and - replicas share to understand, in partial resynchronizations, the part of the - replication stream the replicas needs to fetch to continue. -3. An array composed of three elements array representing the connected - replicas. Every sub-array contains the replica IP, port, and the last - acknowledged replication offset. +2. The current master replication offset, which is an offset that masters and replicas share to understand, in partial resynchronizations, the part of the replication stream the replicas needs to fetch to continue. +3. An array composed of three elements array representing the connected replicas. Every sub-array contains the replica IP, port, and the last acknowledged replication offset. ## Output of the command on replicas @@ -54,16 +46,11 @@ An example of output when `ROLE` is called in a replica instance: The replica output is composed of the following parts: -1. The string `slave`, because of backward compatibility (see note at the end of - this page). +1. The string `slave`, because of backward compatibility (see note at the end of this page). 2. The IP of the master. 3. The port number of the master. -4. The state of the replication from the point of view of the master, that can - be `connect` (the instance needs to connect to its master), `connecting` (the - master-replica connection is in progress), `sync` (the master and replica are - trying to perform the synchronization), `connected` (the replica is online). -5. The amount of data received from the replica so far in terms of master - replication offset. +4. The state of the replication from the point of view of the master, that can be `connect` (the instance needs to connect to its master), `connecting` (the master-replica connection is in progress), `sync` (the master and replica are trying to perform the synchronization), `connected` (the replica is online). +5. The amount of data received from the replica so far in terms of master replication offset. ## Sentinel output @@ -84,13 +71,7 @@ The sentinel output is composed of the following parts: @return -@array-reply: where the first element is one of `master`, `slave`, `sentinel` -and the additional elements are role-specific as illustrated above. - -@history - -- This command was introduced in the middle of a Redis stable release, - specifically with Redis 2.8.12. +@array-reply: where the first element is one of `master`, `slave`, `sentinel` and the additional elements are role-specific as illustrated above. @examples @@ -98,8 +79,4 @@ and the additional elements are role-specific as illustrated above. ROLE ``` -**A note about the word slave used in this man page**: Starting with Redis 5, if -not for backward compatibility, the Redis project no longer uses the word slave. -Unfortunately in this command the word slave is part of the protocol, so we'll -be able to remove such occurrences only when this API will be naturally -deprecated. +**A note about the word slave used in this man page**: Starting with Redis 5, if not for backward compatibility, the Redis project no longer uses the word slave. Unfortunately in this command the word slave is part of the protocol, so we'll be able to remove such occurrences only when this API will be naturally deprecated. |