RKeysAsync (Redisson 3.4.1 API)

All Known Subinterfaces:

RKeys

All Known Implementing Classes:

RedissonKeys
```
public interface RKeysAsync
```
Author:

Nikita Koksharov

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`RFuture<Boolean>`	`clearExpireAsync(String name)` Clear an expire timeout or expire date for object.
`RFuture<Long>`	`countAsync()` Returns the number of keys in the currently-selected database in async mode
`RFuture<Long>`	`countExistsAsync(String... names)` Checks if provided keys exist
`RFuture<Long>`	`deleteAsync(RObject... objects)` Delete multiple objects
`RFuture<Long>`	`deleteAsync(String... keys)` Delete multiple objects by name
`RFuture<Long>`	`deleteByPatternAsync(String pattern)` Delete multiple objects by a key pattern.
`RFuture<Boolean>`	`expireAsync(String name, long timeToLive, TimeUnit timeUnit)` Set a timeout for object.
`RFuture<Boolean>`	`expireAtAsync(String name, long timestamp)` Set an expire date for object.
`RFuture<Collection<String>>`	`findKeysByPatternAsync(String pattern)` Find keys by key search pattern in async mode Supported glob-style patterns: h?
`RFuture<Void>`	`flushallAsync()` Delete all keys of all existing databases
`RFuture<Void>`	`flushdbAsync()` Delete all keys of currently selected database
`RFuture<Integer>`	`getSlotAsync(String key)` Get hash slot identifier for key in async mode.
`RFuture<RType>`	`getTypeAsync(String key)` Get Redis object type by key
`RFuture<Void>`	`migrateAsync(String name, String host, int port, int database)` Transfer an object from source Redis instance to destination Redis instance
`RFuture<Boolean>`	`moveAsync(String name, int database)` Move object to another database
`RFuture<String>`	`randomKeyAsync()` Get random key in async mode
`RFuture<Long>`	`remainTimeToLiveAsync(String name)` Remaining time to live of Redisson object that has a timeout
`RFuture<Void>`	`renameAsync(String currentName, String newName)` Rename current object key to `newName`
`RFuture<Boolean>`	`renamenxAsync(String oldName, String newName)` Rename object with `oldName` to `newName` only if new key is not exists
`RFuture<Long>`	`touchAsync(String... names)` Update the last access time of an object.

- Method Detail
  - moveAsync
```
RFuture<Boolean> moveAsync(String name,
                           int database)
```
    Move object to another database
    
    Parameters:
    
    name - of object
    
    database - - Redis database number
    
    Returns:
    
    true if key was moved else false
  - migrateAsync
```
RFuture<Void> migrateAsync(String name,
                           String host,
                           int port,
                           int database)
```
    Transfer an object from source Redis instance to destination Redis instance
    
    Parameters:
    
    name - of object
    
    host - - destination host
    
    port - - destination port
    
    database - - destination database
  - expireAsync
```
RFuture<Boolean> expireAsync(String name,
                             long timeToLive,
                             TimeUnit timeUnit)
```
    Set a timeout for object. After the timeout has expired, the key will automatically be deleted.
    
    Parameters:
    
    name - of object
    
    timeToLive - - timeout before object will be deleted
    
    timeUnit - - timeout time unit
    
    Returns:
    
    true if the timeout was set and false if not
  - expireAtAsync
```
RFuture<Boolean> expireAtAsync(String name,
                               long timestamp)
```
    Set an expire date for object. When expire date comes the key will automatically be deleted.
    
    Parameters:
    
    name - of object
    
    timestamp - - expire date in milliseconds (Unix timestamp)
    
    Returns:
    
    true if the timeout was set and false if not
  - clearExpireAsync
```
RFuture<Boolean> clearExpireAsync(String name)
```
    Clear an expire timeout or expire date for object.
    
    Parameters:
    
    name - of object
    
    Returns:
    
    true if timeout was removed false if object does not exist or does not have an associated timeout
  - renamenxAsync
```
RFuture<Boolean> renamenxAsync(String oldName,
                               String newName)
```
    Rename object with oldName to newName only if new key is not exists
    
    Parameters:
    
    oldName - - old name of object
    
    newName - - new name of object
    
    Returns:
    
    true if object has been renamed successfully and false otherwise
  - renameAsync
```
RFuture<Void> renameAsync(String currentName,
                          String newName)
```
    Rename current object key to newName
    
    Parameters:
    
    currentName - - current name of object
    
    newName - - new name of object
  - remainTimeToLiveAsync
```
RFuture<Long> remainTimeToLiveAsync(String name)
```
    Remaining time to live of Redisson object that has a timeout
    
    Parameters:
    
    name - of key
    
    Returns:
    
    time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.
  - touchAsync
```
RFuture<Long> touchAsync(String... names)
```
    Update the last access time of an object.
    
    Parameters:
    
    names - of keys
    
    Returns:
    
    count of objects were touched
  - countExistsAsync
```
RFuture<Long> countExistsAsync(String... names)
```
    Checks if provided keys exist
    
    Parameters:
    
    names - of keys
    
    Returns:
    
    amount of existing keys
  - getTypeAsync
```
RFuture<RType> getTypeAsync(String key)
```
    Get Redis object type by key
    
    Parameters:
    
    key - - name of key
    
    Returns:
    
    type of key
  - getSlotAsync
```
RFuture<Integer> getSlotAsync(String key)
```
    Get hash slot identifier for key in async mode. Available for cluster nodes only
    
    Parameters:
    
    key - - name of key
    
    Returns:
    
    slot
  - randomKeyAsync
```
RFuture<String> randomKeyAsync()
```
    Get random key in async mode
    
    Returns:
    
    random key
  - findKeysByPatternAsync
```
RFuture<Collection<String>> findKeysByPatternAsync(String pattern)
```
    Find keys by key search pattern in async mode Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo
    
    Parameters:
    
    pattern - - match pattern
    
    Returns:
    
    collections of keys
  - deleteByPatternAsync
```
RFuture<Long> deleteByPatternAsync(String pattern)
```
    Delete multiple objects by a key pattern.
    Method executes in NON atomic way in cluster mode due to lua script limitations.
    Supported glob-style patterns: h?llo subscribes to hello, hallo and hxllo h*llo subscribes to hllo and heeeello h[ae]llo subscribes to hello and hallo, but not hillo
    
    Parameters:
    
    pattern - - match pattern
    
    Returns:
    
    number of removed keys
  - deleteAsync
```
RFuture<Long> deleteAsync(RObject... objects)
```
    Delete multiple objects
    
    Parameters:
    
    objects - of Redisson
    
    Returns:
    
    number of removed keys
  - deleteAsync
```
RFuture<Long> deleteAsync(String... keys)
```
    Delete multiple objects by name
    
    Parameters:
    
    keys - - object names
    
    Returns:
    
    number of removed keys
  - countAsync
```
RFuture<Long> countAsync()
```
    Returns the number of keys in the currently-selected database in async mode
    
    Returns:
    
    number of keys
  - flushdbAsync
```
RFuture<Void> flushdbAsync()
```
    Delete all keys of currently selected database
    
    Returns:
    
    void
  - flushallAsync
```
RFuture<Void> flushallAsync()
```
    Delete all keys of all existing databases
    
    Returns:
    
    void

Interface RKeysAsync

Method Summary

Method Detail

moveAsync

migrateAsync

expireAsync

expireAtAsync

clearExpireAsync

renamenxAsync

renameAsync

remainTimeToLiveAsync

touchAsync

countExistsAsync

getTypeAsync

getSlotAsync

randomKeyAsync

findKeysByPatternAsync

deleteByPatternAsync

deleteAsync

deleteAsync

countAsync

flushdbAsync

flushallAsync