Docs

API Reference Redis

ROLE

YugaByte DB only has master role for the Redis API.

SYNOPSIS

ROLE
This command provides information of a Redis instance, such as its role, its state of replication, its slaves, or its master. Roles are either “master”, “slave”, or “sentinel”.

  • Information of a master instance may include the following.
    1. “master”
    2. An integer that represents state of replication
    3. An array of connected slaves { IP address, IP port, State of replication }

  • Information of a slave instance may include the following.
    1. “slave”
    2. Master IP address
    3. Master IP port
    4. Connection state that is either “disconnected”, “connecting”, “sync”, or “connected”
    5. An integer that represents state of replication

  • Information of a sentinel instance may include the following.
    1. “sentinel”
    2. An array of master names.

    • RETURN VALUE

    Returns an array of values.

    EXAMPLES

    $ ROLE

    1) "master"
2) 0
3) 1) 1) "127.0.0.1"
      2) "9200"
      3) "0"
   2) 1) "127.0.0.1"
      2) "9201"
      3) "0"

    SEE ALSO

    auth, config