Module lettuce.core

Interface RedisServerReactiveCommands<K,​V>

Type Parameters:
K - Key type.
V - Value type.
All Known Subinterfaces:
RedisAdvancedClusterReactiveCommands<K,​V>, RedisClusterPubSubReactiveCommands<K,​V>, RedisClusterReactiveCommands<K,​V>, RedisPubSubReactiveCommands<K,​V>, RedisReactiveCommands<K,​V>
All Known Implementing Classes:
AbstractRedisReactiveCommands, RedisAdvancedClusterReactiveCommandsImpl, RedisClusterPubSubReactiveCommandsImpl, RedisPubSubReactiveCommandsImpl, RedisReactiveCommandsImpl, RedisSentinelReactiveCommandsImpl

public interface RedisServerReactiveCommands<K,​V>
Reactive executed commands for Server Control.
Since:
4.0
Author:
Mark Paluch
Generated class:
by io.lettuce.apigenerator.CreateReactiveApi
  • Method Details

    • bgrewriteaof

      Mono<String> bgrewriteaof()
      Asynchronously rewrite the append-only file.
      Returns:
      String simple-string-reply always OK.
    • bgsave

      Mono<String> bgsave()
      Asynchronously save the dataset to disk.
      Returns:
      String simple-string-reply.
    • clientCaching

      Mono<String> clientCaching​(boolean enabled)
      Control tracking of keys in the context of server-assisted client cache invalidation.
      Parameters:
      enabled - true to enable key tracking.
      Returns:
      String simple-string-reply OK.
      Since:
      6.0
    • clientGetname

      Mono<K> clientGetname()
      Get the current connection name.
      Returns:
      K bulk-string-reply The connection name, or a null bulk reply if no name is set.
    • clientGetredir

      Mono<Long> clientGetredir()
      Returns the client ID we are redirecting our tracking notifications to.
      Returns:
      the ID of the client we are redirecting the notifications to. The command returns -1 if client tracking is not enabled, or 0 if client tracking is enabled but we are not redirecting the notifications to any client.
      Since:
      6.0
    • clientId

      Mono<Long> clientId()
      Get the id of the current connection.
      Returns:
      Long The command just returns the ID of the current connection.
      Since:
      5.3
    • clientKill

      Mono<String> clientKill​(String addr)
      Kill the connection of a client identified by ip:port.
      Parameters:
      addr - ip:port.
      Returns:
      String simple-string-reply OK if the connection exists and has been closed.
    • clientKill

      Mono<Long> clientKill​(KillArgs killArgs)
      Kill connections of clients which are filtered by killArgs.
      Parameters:
      killArgs - args for the kill operation.
      Returns:
      Long integer-reply number of killed connections.
    • clientList

      Mono<String> clientList()
      Get the list of client connections.
      Returns:
      String bulk-string-reply a unique string, formatted as follows: One client connection per line (separated by LF), each line is composed of a succession of property=value fields separated by a space character.
    • clientPause

      Mono<String> clientPause​(long timeout)
      Stop processing commands from clients for some time.
      Parameters:
      timeout - the timeout value in milliseconds.
      Returns:
      String simple-string-reply The command returns OK or an error if the timeout is invalid.
    • clientSetname

      Mono<String> clientSetname​(K name)
      Set the current connection name.
      Parameters:
      name - the client name.
      Returns:
      simple-string-reply OK if the connection name was successfully set.
    • clientTracking

      Mono<String> clientTracking​(TrackingArgs args)
      Enables the tracking feature of the Redis server, that is used for server assisted client side caching. Tracking messages are either available when using the RESP3 protocol or through Pub/Sub notification when using RESP2.
      Parameters:
      args - for the CLIENT TRACKING operation.
      Returns:
      String simple-string-reply OK.
      Since:
      6.0
    • clientUnblock

      Mono<Long> clientUnblock​(long id, UnblockType type)
      Unblock the specified blocked client.
      Parameters:
      id - the client id.
      type - unblock type.
      Returns:
      Long integer-reply number of unblocked connections.
      Since:
      5.1
    • command

      Flux<Object> command()
      Returns an array reply of details about all Redis commands.
      Returns:
      Object array-reply.
    • commandCount

      Mono<Long> commandCount()
      Get total number of Redis commands.
      Returns:
      Long integer-reply of number of total commands in this Redis server.
    • commandInfo

      Flux<Object> commandInfo​(String... commands)
      Returns an array reply of details about the requested commands.
      Parameters:
      commands - the commands to query for.
      Returns:
      Object array-reply.
    • commandInfo

      Flux<Object> commandInfo​(CommandType... commands)
      Returns an array reply of details about the requested commands.
      Parameters:
      commands - the commands to query for.
      Returns:
      Object array-reply.
    • configGet

      Mono<Map<String,​String>> configGet​(String parameter)
      Get the value of a configuration parameter.
      Parameters:
      parameter - name of the parameter.
      Returns:
      Map<String, String> bulk-string-reply.
    • configResetstat

      Mono<String> configResetstat()
      Reset the stats returned by INFO.
      Returns:
      String simple-string-reply always OK.
    • configRewrite

      Mono<String> configRewrite()
      Rewrite the configuration file with the in memory configuration.
      Returns:
      String simple-string-reply OK when the configuration was rewritten properly. Otherwise an error is returned.
    • configSet

      Mono<String> configSet​(String parameter, String value)
      Set a configuration parameter to the given value.
      Parameters:
      parameter - the parameter name.
      value - the parameter value.
      Returns:
      String simple-string-reply: OK when the configuration was set properly. Otherwise an error is returned.
    • dbsize

      Mono<Long> dbsize()
      Return the number of keys in the selected database.
      Returns:
      Long integer-reply.
    • debugCrashAndRecover

      Mono<String> debugCrashAndRecover​(Long delay)
      Crash and recover.
      Parameters:
      delay - optional delay in milliseconds.
      Returns:
      String simple-string-reply.
    • debugHtstats

      Mono<String> debugHtstats​(int db)
      Get debugging information about the internal hash-table state.
      Parameters:
      db - the database number.
      Returns:
      String simple-string-reply.
    • debugObject

      Mono<String> debugObject​(K key)
      Get debugging information about a key.
      Parameters:
      key - the key.
      Returns:
      String simple-string-reply.
    • debugOom

      Mono<Void> debugOom()
      Make the server crash: Out of memory.
      Returns:
      nothing, because the server crashes before returning.
    • debugReload

      Mono<String> debugReload()
      Save RDB, clear the database and reload RDB.
      Returns:
      String simple-string-reply The commands returns OK on success.
    • debugRestart

      Mono<String> debugRestart​(Long delay)
      Restart the server gracefully.
      Parameters:
      delay - optional delay in milliseconds.
      Returns:
      String simple-string-reply.
    • debugSdslen

      Mono<String> debugSdslen​(K key)
      Get debugging information about the internal SDS length.
      Parameters:
      key - the key.
      Returns:
      String simple-string-reply.
    • debugSegfault

      Mono<Void> debugSegfault()
      Make the server crash: Invalid pointer access.
      Returns:
      nothing, because the server crashes before returning.
    • flushall

      Mono<String> flushall()
      Remove all keys from all databases.
      Returns:
      String simple-string-reply.
    • flushall

      Mono<String> flushall​(FlushMode flushMode)
      Remove all keys from all databases using the specified FlushMode.
      Parameters:
      flushMode - the flush mode (sync/asnync).
      Returns:
      String simple-string-reply.
      Since:
      6.1
    • flushallAsync

      @Deprecated Mono<String> flushallAsync()
      Deprecated.
      since 6.1, use flushall(FlushMode) instead.
      Remove all keys asynchronously from all databases.
      Returns:
      String simple-string-reply.
    • flushdb

      Mono<String> flushdb()
      Remove all keys from the current database.
      Returns:
      String simple-string-reply.
    • flushdb

      Mono<String> flushdb​(FlushMode flushMode)
      Remove all keys from the current database using the specified FlushMode.
      Parameters:
      flushMode - the flush mode (sync/asnync).
      Returns:
      String simple-string-reply.
      Since:
      6.1
    • flushdbAsync

      @Deprecated Mono<String> flushdbAsync()
      Deprecated.
      since 6.1, use flushdb(FlushMode) instead.
      Remove all keys asynchronously from the current database.
      Returns:
      String simple-string-reply.
    • info

      Mono<String> info()
      Get information and statistics about the server.
      Returns:
      String bulk-string-reply as a collection of text lines.
    • info

      Mono<String> info​(String section)
      Get information and statistics about the server.
      Parameters:
      section - the section type: string.
      Returns:
      String bulk-string-reply as a collection of text lines.
    • lastsave

      Mono<Date> lastsave()
      Get the UNIX time stamp of the last successful save to disk.
      Returns:
      Date integer-reply an UNIX time stamp.
    • memoryUsage

      Mono<Long> memoryUsage​(K key)
      Reports the number of bytes that a key and its value require to be stored in RAM.
      Returns:
      memory usage in bytes.
      Since:
      5.2
    • save

      Mono<String> save()
      Synchronously save the dataset to disk.
      Returns:
      String simple-string-reply The commands returns OK on success.
    • shutdown

      Mono<Void> shutdown​(boolean save)
      Synchronously save the dataset to disk and then shut down the server.
      Parameters:
      save - true force save operation.
    • slaveof

      Mono<String> slaveof​(String host, int port)
      Make the server a replica of another instance, or promote it as master.
      Parameters:
      host - the host type: string.
      port - the port type: string.
      Returns:
      String simple-string-reply.
    • slaveofNoOne

      Mono<String> slaveofNoOne()
      Promote server as master.
      Returns:
      String simple-string-reply.
    • slowlogGet

      Flux<Object> slowlogGet()
      Read the slow log.
      Returns:
      Object deeply nested multi bulk replies.
    • slowlogGet

      Flux<Object> slowlogGet​(int count)
      Read the slow log.
      Parameters:
      count - the count.
      Returns:
      Object deeply nested multi bulk replies.
    • slowlogLen

      Mono<Long> slowlogLen()
      Obtaining the current length of the slow log.
      Returns:
      Long length of the slow log.
    • slowlogReset

      Mono<String> slowlogReset()
      Resetting the slow log.
      Returns:
      String simple-string-reply The commands returns OK on success.
    • time

      Flux<V> time()
      Return the current server time.
      Returns:
      V array-reply specifically: A multi bulk reply containing two elements: unix time in seconds. microseconds.