Package org.redisson.api

Interface RKeys

All Superinterfaces:

RKeysAsync

All Known Implementing Classes:

RedissonKeys

public interface RKeys
extends RKeysAsync

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
boolean	clearExpire(String name)	Clear an expire timeout or expire date for object.
void	copy(String name, String host, int port, int database, long timeout)	Copy object from source Redis instance to destination Redis instance
long	count()	Returns the number of keys in the currently-selected database
long	countExists(String... names)	Checks if provided keys exist
long	delete(String... keys)	Delete multiple objects by name
long	delete(RObject... objects)	Delete multiple objects
long	deleteByPattern(String pattern)	Delete multiple objects by a key pattern.
boolean	expire(String name, long timeToLive, TimeUnit timeUnit)	Set a timeout for object.
boolean	expireAt(String name, long timestamp)	Set an expire date for object.
void	flushall()	Delete all keys of all existing databases
void	flushallParallel()	Delete all keys of all existing databases in background without blocking server.
void	flushdb()	Delete all keys of currently selected database
void	flushdbParallel()	Delete all keys of currently selected database in background without blocking server.
Iterable<String>	getKeys()	Get all keys using iterator.
Iterable<String>	getKeys(int count)	Get all keys using iterator.
Iterable<String>	getKeysByPattern(String pattern)	Get all keys by pattern using iterator.
Iterable<String>	getKeysByPattern(String pattern, int count)	Get all keys by pattern using iterator.
Stream<String>	getKeysStream()	Get all keys using Stream.
Stream<String>	getKeysStream(int count)	Get all keys using Stream.
Stream<String>	getKeysStreamByPattern(String pattern)	Get all keys by pattern using Stream.
Stream<String>	getKeysStreamByPattern(String pattern, int count)	Get all keys by pattern using Stream.
Iterable<String>	getKeysWithLimit(int limit)	Get keys using iterator with defined limit.
Iterable<String>	getKeysWithLimit(String pattern, int limit)	Get keys using iterator with defined limit.
int	getSlot(String key)	Get hash slot identifier for key.
RType	getType(String key)	Get Redis object type by key
void	migrate(String name, String host, int port, int database, long timeout)	Transfer object from source Redis instance to destination Redis instance
boolean	move(String name, int database)	Move object to another database
String	randomKey()	Get random key
long	remainTimeToLive(String name)	Remaining time to live of Redisson object that has a timeout
void	rename(String currentName, String newName)	Rename current object key to newName
boolean	renamenx(String oldName, String newName)	Rename object with oldName to newName only if new key is not exists
void	swapdb(int db1, int db2)	Swap two databases.
long	touch(String... names)	Update the last access time of an object.
long	unlink(String... keys)	Delete multiple objects by name.

Methods inherited from interface org.redisson.api.RKeysAsync

clearExpireAsync, copyAsync, countAsync, countExistsAsync, deleteAsync, deleteAsync, deleteByPatternAsync, expireAsync, expireAtAsync, flushallAsync, flushallParallelAsync, flushdbAsync, flushdbParallelAsync, getSlotAsync, getTypeAsync, migrateAsync, moveAsync, randomKeyAsync, remainTimeToLiveAsync, renameAsync, renamenxAsync, swapdbAsync, touchAsync, unlinkAsync

Method Detail

getKeysWithLimit

Iterable<String> getKeysWithLimit(int limit)

Get keys using iterator with defined limit. Keys are traversed with SCAN operation.

Parameters:

limit - - limit of keys amount

Returns:

Iterable object

getKeysWithLimit

Iterable<String> getKeysWithLimit(String pattern,
                                  int limit)

Get keys using iterator with defined limit. Keys are traversed with SCAN operation.

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:

limit - - limit of keys amount

pattern - - match pattern

Returns:

Iterable object

move

boolean move(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

migrate

void migrate(String name,
             String host,
             int port,
             int database,
             long timeout)

Transfer object from source Redis instance to destination Redis instance

Parameters:

name - of object

host - - destination host

port - - destination port

database - - destination database

timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds

copy

void copy(String name,
          String host,
          int port,
          int database,
          long timeout)

Copy object from source Redis instance to destination Redis instance

Parameters:

name - of object

host - - destination host

port - - destination port

database - - destination database

timeout - - maximum idle time in any moment of the communication with the destination instance in milliseconds

expire

boolean expire(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

expireAt

boolean expireAt(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

clearExpire

boolean clearExpire(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

renamenx

boolean renamenx(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

rename

void rename(String currentName,
            String newName)

Rename current object key to newName

Parameters:

currentName - - current name of object

newName - - new name of object

remainTimeToLive

long remainTimeToLive(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.

touch

long touch(String... names)

Update the last access time of an object.

Parameters:

names - of keys

Returns:

count of objects were touched

countExists

long countExists(String... names)

Checks if provided keys exist

Parameters:

names - of keys

Returns:

amount of existing keys

getType

RType getType(String key)

Get Redis object type by key

Parameters:

key - - name of key

Returns:

type of key

getSlot

int getSlot(String key)

Get hash slot identifier for key. Available for cluster nodes only

Parameters:

key - - name of key

Returns:

slot number

getKeysByPattern

Iterable<String> getKeysByPattern(String pattern)

Get all keys by pattern using iterator. Keys traversed with SCAN operation. Each SCAN operation loads up to 10 keys per request.

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:

Iterable object

getKeysByPattern

Iterable<String> getKeysByPattern(String pattern,
                                  int count)

Get all keys by pattern using iterator. Keys traversed with SCAN operation. Each SCAN operation loads up to count keys per request.

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

count - - keys loaded per request to Redis

Returns:

Iterable object

getKeys

Iterable<String> getKeys()

Get all keys using iterator. Keys traversing with SCAN operation. Each SCAN operation loads up to 10 keys per request.

Returns:

Iterable object

getKeys

Iterable<String> getKeys(int count)

Get all keys using iterator. Keys traversing with SCAN operation. Each SCAN operation loads up to count keys per request.

Parameters:

count - - keys loaded per request to Redis

Returns:

Iterable object

getKeysStreamByPattern

Stream<String> getKeysStreamByPattern(String pattern)

Get all keys by pattern using Stream. Keys traversed with SCAN operation. Each SCAN operation loads up to 10 keys per request.

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:

Iterable object

getKeysStreamByPattern

Stream<String> getKeysStreamByPattern(String pattern,
                                      int count)

Get all keys by pattern using Stream. Keys traversed with SCAN operation. Each SCAN operation loads up to count keys per request.

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

count - - keys loaded per request to Redis

Returns:

Iterable object

getKeysStream

Stream<String> getKeysStream()

Get all keys using Stream. Keys traversing with SCAN operation. Each SCAN operation loads up to 10 keys per request.

Returns:

Iterable object

getKeysStream

Stream<String> getKeysStream(int count)

Get all keys using Stream. Keys traversing with SCAN operation. Each SCAN operation loads up to count keys per request.

Parameters:

count - - keys loaded per request to Redis

Returns:

Iterable object

randomKey

String randomKey()

Get random key

Returns:

random key

deleteByPattern

long deleteByPattern(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

delete

long delete(RObject... objects)

Delete multiple objects

Parameters:

objects - of Redisson

Returns:

number of removed keys

delete

long delete(String... keys)

Delete multiple objects by name

Parameters:

keys - - object names

Returns:

number of removed keys

unlink

long unlink(String... keys)

Delete multiple objects by name. Actual removal will happen later asynchronously.

Requires Redis 4.0+

Parameters:

keys - of objects

Returns:

number of removed keys

count

long count()

Returns the number of keys in the currently-selected database

Returns:

count of keys

swapdb

void swapdb(int db1,
            int db2)

Swap two databases.

flushdb

void flushdb()

Delete all keys of currently selected database

flushdbParallel

void flushdbParallel()

Delete all keys of currently selected database in background without blocking server.

Requires Redis 4.0+

flushall

void flushall()

Delete all keys of all existing databases

flushallParallel

void flushallParallel()

Delete all keys of all existing databases in background without blocking server.

Requires Redis 4.0+