Package redis.clients.jedis.commands

Interface ServerCommands

All Known Implementing Classes:
Jedis
public interface ServerCommands

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    auth(String password)
    Request for authentication in a password-protected Redis server.
    String
    auth(String user, String password)
    Request for authentication with username and password, based on the ACL feature introduced in Redis 6.0 see https://redis.io/topics/acl
    String
    bgrewriteaof()
    Instruct Redis to start an Append Only File rewrite process.
    String
    bgsave()
    Save the DB in background.
    String
    bgsaveSchedule()
     
    byte[]
    echo(byte[] arg)
     
    String
    echo(String string)
     
    String
    flushAll()
    Delete all the keys of all the existing databases, not just the currently selected one.
    String
    flushAll(FlushMode flushMode)
    Delete all the keys of all the existing databases, not just the currently selected one.
    String
    flushDB()
    Delete all the keys of the currently selected DB.
    String
    flushDB(FlushMode flushMode)
    Delete all the keys of the currently selected DB.
    String
    info()
    The INFO command returns information and statistics about the server in a format that is simple to parse by computers and easy to read by humans.
    String
    info(String section)
    The INFO command returns information and statistics about the server in a format that is simple to parse by computers and easy to read by humans.
    long
    lastsave()
    Return the UNIX TIME of the last DB save executed with success.
    String
    latencyDoctor()
    The LATENCY DOCTOR command reports about different latency-related issues and advises about possible remedies.
    String
    lolwut()
     
    String
    lolwut(LolwutParams lolwutParams)
     
    String
    ping()
    This command is often used to test if a connection is still alive, or to measure latency.
    String
    ping(String message)
     
    String
    quit()
    Deprecated.
    The QUIT command is deprecated, see #11420.
    String
    replicaof(String host, int port)
    The REPLICAOF command can change the replication settings of a replica on the fly.
    String
    replicaofNoOne()
    REPLICAOF NO ONE will stop replication, turning the server into a MASTER, but will not discard the replication.
    String
    save()
    The SAVE commands performs a synchronous save of the dataset producing a point in time snapshot of all the data inside the Redis instance, in the form of an RDB file.
    void
    shutdown()
    Stop all the client.
    void
    shutdown(SaveMode saveMode)
    Deprecated.
    Use shutdown(redis.clients.jedis.params.ShutdownParams).
    void
    shutdown(ShutdownParams shutdownParams)
     
    String
    shutdownAbort()
     
    String
    slaveof(String host, int port)
    Deprecated.
    Use replicaof(java.lang.String, int).
    String
    slaveofNoOne()
    Deprecated.
    Use replicaofNoOne().
    KeyValue<Long,Long>
    waitAOF(long numLocal, long numReplicas, long timeout)
    Blocks the current client until all the previous write commands are acknowledged as having been fsynced to the AOF of the local Redis and/or at least the specified number of replicas.
    long
    waitReplicas(int replicas, long timeout)
    Synchronous replication of Redis as described here: http://antirez.com/news/66.

  • Method Details

    • ping

      String ping()
      This command is often used to test if a connection is still alive, or to measure latency.
      Returns:
      PONG

    • ping

      String ping(String message)

    • echo

      String echo(String string)

    • echo

      byte[] echo(byte[] arg)

    • quit

      @Deprecated String quit()
      Deprecated.
      The QUIT command is deprecated, see #11420. If available, disconnect() method in the concerned class can be used instead.
      Ask the server to close the connection. The connection is closed as soon as all pending replies have been written to the client.
      Returns:
      OK

    • flushDB

      String flushDB()
      Delete all the keys of the currently selected DB. This command never fails. The time-complexity for this operation is O(N), N being the number of keys in the database.
      Returns:
      OK

    • flushDB

      String flushDB(FlushMode flushMode)
      Delete all the keys of the currently selected DB. This command never fails. The time-complexity for this operation is O(N), N being the number of keys in the database.
      Parameters:
      flushMode - can be SYNC or ASYNC
      Returns:
      OK

    • flushAll

      String flushAll()
      Delete all the keys of all the existing databases, not just the currently selected one.
      Returns:
      a simple string reply (OK)

    • flushAll

      String flushAll(FlushMode flushMode)
      Delete all the keys of all the existing databases, not just the currently selected one.
      Parameters:
      flushMode - SYNC or ASYNC
      Returns:
      a simple string reply (OK)

    • auth

      String auth(String password)
      Request for authentication in a password-protected Redis server. Redis can be instructed to require a password before allowing clients to execute commands. This is done using the requirepass directive in the configuration file. If password matches the password in the configuration file, the server replies with the OK status code and starts accepting commands. Otherwise, an error is returned and the clients needs to try a new password.
      Returns:
      the result of the auth

    • auth

      String auth(String user, String password)
      Request for authentication with username and password, based on the ACL feature introduced in Redis 6.0 see https://redis.io/topics/acl
      Returns:
      OK

    • save

      String save()
      The SAVE commands performs a synchronous save of the dataset producing a point in time snapshot of all the data inside the Redis instance, in the form of an RDB file. You almost never want to call SAVE in production environments where it will block all the other clients. Instead usually BGSAVE is used. However in case of issues preventing Redis to create the background saving child (for instance errors in the fork(2) system call), the SAVE command can be a good last resort to perform the dump of the latest dataset.
      Returns:
      result of the save

    • bgsave

      String bgsave()
      Save the DB in background. The OK code is immediately returned. Redis forks, the parent continues to serve the clients, the child saves the DB on disk then exits. A client may be able to check if the operation succeeded using the LASTSAVE command.
      Returns:
      ok

    • bgsaveSchedule

      String bgsaveSchedule()

    • bgrewriteaof

      String bgrewriteaof()
      Instruct Redis to start an Append Only File rewrite process. The rewrite will create a small optimized version of the current Append Only File If BGREWRITEAOF fails, no data gets lost as the old AOF will be untouched. The rewrite will be only triggered by Redis if there is not already a background process doing persistence. Specifically: If a Redis child is creating a snapshot on disk, the AOF rewrite is scheduled but not started until the saving child producing the RDB file terminates. In this case the BGREWRITEAOF will still return an OK code, but with an appropriate message. You can check if an AOF rewrite is scheduled looking at the INFO command as of Redis 2.6. If an AOF rewrite is already in progress the command returns an error and no AOF rewrite will be scheduled for a later time. Since Redis 2.4 the AOF rewrite is automatically triggered by Redis, however the BGREWRITEAOF command can be used to trigger a rewrite at any time.
      Returns:
      the response of the command

    • lastsave

      long lastsave()
      Return the UNIX TIME of the last DB save executed with success.
      Returns:
      the unix latest save

    • shutdown

      void shutdown() throws JedisException
      Stop all the client. Perform a SAVE (if one save point is configured). Flush the append only file if AOF is enabled quit the server
      Throws:
      JedisException - only in case of error.

    • shutdown

      @Deprecated void shutdown(SaveMode saveMode) throws JedisException
      Deprecated.
      Use shutdown(redis.clients.jedis.params.ShutdownParams).
      Parameters:
      saveMode - modifier to alter the data save behavior of SHUTDOWN. null would trigger the default behavior.
      Throws:
      JedisException
      See Also:

    • shutdown

      void shutdown(ShutdownParams shutdownParams) throws JedisException
      Parameters:
      shutdownParams - set commands parameters
      Throws:
      JedisException
      See Also:

    • shutdownAbort

      String shutdownAbort()

    • info

      String info()
      The INFO command returns information and statistics about the server in a format that is simple to parse by computers and easy to read by humans.
      Returns:
      information on the server

    • info

      String info(String section)
      The INFO command returns information and statistics about the server in a format that is simple to parse by computers and easy to read by humans.
      Parameters:
      section - (all: Return all sections, default: Return only the default set of sections, server: General information about the Redis server, clients: Client connections section, memory: Memory consumption related information, persistence: RDB and AOF related information, stats: General statistics, replication: Master/slave replication information, cpu: CPU consumption statistics, commandstats: Redis command statistics, cluster: Redis Cluster section, keyspace: Database related statistics)
      Returns:
      info

    • slaveof

      @Deprecated String slaveof(String host, int port)
      Deprecated.
      Use replicaof(java.lang.String, int).
      The SLAVEOF command can change the replication settings of a slave on the fly. In the proper form SLAVEOF hostname port will make the server a slave of another server listening at the specified hostname and port. If a server is already a slave of some master, SLAVEOF hostname port will stop the replication against the old server and start the synchronization against the new one, discarding the old dataset.
      Parameters:
      host - listening at the specified hostname
      port - server listening at the specified port
      Returns:
      result of the command.

    • slaveofNoOne

      @Deprecated String slaveofNoOne()
      Deprecated.
      Use replicaofNoOne().
      SLAVEOF NO ONE will stop replication, turning the server into a MASTER, but will not discard the replication. So, if the old master stops working, it is possible to turn the slave into a master and set the application to use this new master in read/write. Later when the other Redis server is fixed, it can be reconfigured to work as a slave.
      Returns:
      result of the command

    • replicaof

      String replicaof(String host, int port)
      The REPLICAOF command can change the replication settings of a replica on the fly. In the proper form REPLICAOF hostname port will make the server a replica of another server listening at the specified hostname and port. If a server is already a replica of some master, REPLICAOF hostname port will stop the replication against the old server and start the synchronization against the new one, discarding the old dataset.
      Parameters:
      host - listening at the specified hostname
      port - server listening at the specified port
      Returns:
      result of the command.

    • replicaofNoOne

      String replicaofNoOne()
      REPLICAOF NO ONE will stop replication, turning the server into a MASTER, but will not discard the replication. So, if the old master stops working, it is possible to turn the replica into a master and set the application to use this new master in read/write. Later when the other Redis server is fixed, it can be reconfigured to work as a replica.
      Returns:
      result of the command

    • waitReplicas

      long waitReplicas(int replicas, long timeout)
      Synchronous replication of Redis as described here: http://antirez.com/news/66.

      Blocks until all the previous write commands are successfully transferred and acknowledged by at least the specified number of replicas. If the timeout, specified in milliseconds, is reached, the command returns even if the specified number of replicas were not yet reached.

      Since Java Object class has implemented wait method, we cannot use it.

      Parameters:
      replicas - successfully transferred and acknowledged by at least the specified number of replicas
      timeout - the time to block in milliseconds, a timeout of 0 means to block forever
      Returns:
      the number of replicas reached by all the writes performed in the context of the current connection

    • waitAOF

      KeyValue<Long,Long> waitAOF(long numLocal, long numReplicas, long timeout)
      Blocks the current client until all the previous write commands are acknowledged as having been fsynced to the AOF of the local Redis and/or at least the specified number of replicas. Redis Documentation
      Parameters:
      numLocal - Number of local instances that are required to acknowledge the sync (0 or 1), cannot be non-zero if the local Redis does not have AOF enabled
      numReplicas - Number of replicas that are required to acknowledge the sync
      timeout - Timeout in millis of the operation - if 0 timeout is unlimited. If the timeout is reached, the command returns even if the specified number of acknowledgments has not been met.
      Returns:
      KeyValue where Key is number of local Redises (0 or 1) that have fsynced to AOF all writes performed in the context of the current connection, and the value is the number of replicas that have acknowledged doing the same.

    • lolwut

      String lolwut()

    • lolwut

      String lolwut(LolwutParams lolwutParams)

    • latencyDoctor

      String latencyDoctor()
      The LATENCY DOCTOR command reports about different latency-related issues and advises about possible remedies.

      This command is the most powerful analysis tool in the latency monitoring framework, and is able to provide additional statistical data like the average period between latency spikes, the median deviation, and a human-readable analysis of the event. For certain events, like fork, additional information is provided, like the rate at which the system forks processes.

      This is the output you should post in the Redis mailing list if you are looking for help about Latency related issues.

      Returns:
      the report