org.redisson.reactive

Class RedissonKeysReactive

java.lang.Object

org.redisson.reactive.RedissonKeysReactive

All Implemented Interfaces:

RKeysReactive

public class RedissonKeysReactive
extends Object
implements RKeysReactive

Author:

Nikita Koksharov

Constructor Summary

Constructors

Constructor and Description
RedissonKeysReactive(CommandReactiveService commandExecutor)

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<Boolean>	clearExpire(String name) Clear an expire timeout or expire date for object.
org.reactivestreams.Publisher<Void>	copy(String name, String host, int port, int database, long timeout) Copy object from source Redis instance to destination Redis instance
org.reactivestreams.Publisher<Long>	count() Returns the number of keys in the currently-selected database
org.reactivestreams.Publisher<Long>	countExists(String... names) Checks if provided keys exist
org.reactivestreams.Publisher<Long>	delete(String... keys) Delete multiple objects by name.
org.reactivestreams.Publisher<Long>	deleteByPattern(String pattern) Delete multiple objects by a key pattern.
org.reactivestreams.Publisher<Boolean>	expire(String name, long timeToLive, TimeUnit timeUnit) Set a timeout for object.
org.reactivestreams.Publisher<Boolean>	expireAt(String name, long timestamp) Set an expire date for object.
org.reactivestreams.Publisher<Collection<String>>	findKeysByPattern(String pattern) Find keys by key search pattern by one Redis call.
org.reactivestreams.Publisher<Void>	flushall() Delete all the keys of all the existing databases Uses FLUSHALL Redis command.
org.reactivestreams.Publisher<Void>	flushdb() Delete all the keys of the currently selected database Uses FLUSHDB Redis command.
org.reactivestreams.Publisher<String>	getKeys() Load keys in incrementally iterate mode.
org.reactivestreams.Publisher<String>	getKeys(int count) Load keys in incrementally iterate mode.
org.reactivestreams.Publisher<String>	getKeysByPattern(String pattern) Find keys by pattern and load it in incrementally iterate mode.
org.reactivestreams.Publisher<String>	getKeysByPattern(String pattern, int count) Get all keys by pattern using iterator.
org.reactivestreams.Publisher<Integer>	getSlot(String key) Get hash slot identifier for key.
org.reactivestreams.Publisher<RType>	getType(String key) Get Redis object type by key
org.reactivestreams.Publisher<Void>	migrate(String name, String host, int port, int database, long timeout) Transfer object from source Redis instance to destination Redis instance
org.reactivestreams.Publisher<Boolean>	move(String name, int database) Move object to another database
org.reactivestreams.Publisher<String>	randomKey() Get random key Uses RANDOM_KEY Redis command.
org.reactivestreams.Publisher<Long>	remainTimeToLive(String name) Remaining time to live of Redisson object that has a timeout
org.reactivestreams.Publisher<Void>	rename(String currentName, String newName) Rename current object key to newName
org.reactivestreams.Publisher<Boolean>	renamenx(String oldName, String newName) Rename object with oldName to newName only if new key is not exists
org.reactivestreams.Publisher<Long>	touch(String... names) Update the last access time of an object.
org.reactivestreams.Publisher<Long>	unlink(String... keys) Delete multiple objects by name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RedissonKeysReactive

public RedissonKeysReactive(CommandReactiveService commandExecutor)

Method Detail

getSlot

public org.reactivestreams.Publisher<Integer> getSlot(String key)

Description copied from interface: RKeysReactive

Get hash slot identifier for key. Available for cluster nodes only. Uses KEYSLOT Redis command.

Specified by:

getSlot in interface RKeysReactive

Parameters:

key - - name of key

Returns:

slot number

getKeysByPattern

public org.reactivestreams.Publisher<String> getKeysByPattern(String pattern)

Description copied from interface: RKeysReactive

Find keys by pattern and load it in incrementally iterate mode. 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

Specified by:

getKeysByPattern in interface RKeysReactive

Parameters:

pattern - - match pattern

Returns:

keys

getKeysByPattern

public org.reactivestreams.Publisher<String> getKeysByPattern(String pattern,
                                                              int count)

Description copied from interface: RKeysReactive

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

Specified by:

getKeysByPattern in interface RKeysReactive

Parameters:

pattern - - match pattern

count - - keys loaded per request to Redis

Returns:

keys

getKeys

public org.reactivestreams.Publisher<String> getKeys()

Description copied from interface: RKeysReactive

Load keys in incrementally iterate mode. Keys traversed with SCAN operation. Each SCAN operation loads up to 10 keys per request.

Specified by:

getKeys in interface RKeysReactive

Returns:

keys

getKeys

public org.reactivestreams.Publisher<String> getKeys(int count)

Description copied from interface: RKeysReactive

Load keys in incrementally iterate mode. Keys traversed with SCAN operation. Each SCAN operation loads up to count keys per request.

Specified by:

getKeys in interface RKeysReactive

Parameters:

count - - keys loaded per request to Redis

Returns:

keys

findKeysByPattern

public org.reactivestreams.Publisher<Collection<String>> findKeysByPattern(String pattern)

Description copied from interface: RKeysReactive

Find keys by key search pattern by one Redis call. Uses KEYS Redis command. 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

Specified by:

findKeysByPattern in interface RKeysReactive

Parameters:

pattern - - match pattern

Returns:

collection of keys

randomKey

public org.reactivestreams.Publisher<String> randomKey()

Description copied from interface: RKeysReactive

Get random key Uses RANDOM_KEY Redis command.

Specified by:

randomKey in interface RKeysReactive

Returns:

random key

deleteByPattern

public org.reactivestreams.Publisher<Long> deleteByPattern(String pattern)

Description copied from interface: RKeysReactive

Delete multiple objects by a key pattern. Uses Lua script. 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

Specified by:

deleteByPattern in interface RKeysReactive

Parameters:

pattern - - match pattern

Returns:

deleted objects amount

delete

public org.reactivestreams.Publisher<Long> delete(String... keys)

Description copied from interface: RKeysReactive

Delete multiple objects by name. Uses DEL Redis command.

Specified by:

delete in interface RKeysReactive

Parameters:

keys - - object names

Returns:

deleted objects amount

flushdb

public org.reactivestreams.Publisher<Void> flushdb()

Description copied from interface: RKeysReactive

Delete all the keys of the currently selected database Uses FLUSHDB Redis command.

Specified by:

flushdb in interface RKeysReactive

Returns:

void

flushall

public org.reactivestreams.Publisher<Void> flushall()

Description copied from interface: RKeysReactive

Delete all the keys of all the existing databases Uses FLUSHALL Redis command.

Specified by:

flushall in interface RKeysReactive

Returns:

void

move

public org.reactivestreams.Publisher<Boolean> move(String name,
                                                   int database)

Description copied from interface: RKeysReactive

Move object to another database

Specified by:

move in interface RKeysReactive

Parameters:

name - of object

database - - Redis database number

Returns:

true if key was moved else false

migrate

public org.reactivestreams.Publisher<Void> migrate(String name,
                                                   String host,
                                                   int port,
                                                   int database,
                                                   long timeout)

Description copied from interface: RKeysReactive

Transfer object from source Redis instance to destination Redis instance

Specified by:

migrate in interface RKeysReactive

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

public org.reactivestreams.Publisher<Void> copy(String name,
                                                String host,
                                                int port,
                                                int database,
                                                long timeout)

Description copied from interface: RKeysReactive

Copy object from source Redis instance to destination Redis instance

Specified by:

copy in interface RKeysReactive

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

public org.reactivestreams.Publisher<Boolean> expire(String name,
                                                     long timeToLive,
                                                     TimeUnit timeUnit)

Description copied from interface: RKeysReactive

Set a timeout for object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RKeysReactive

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

public org.reactivestreams.Publisher<Boolean> expireAt(String name,
                                                       long timestamp)

Description copied from interface: RKeysReactive

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAt in interface RKeysReactive

Parameters:

name - of object

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

clearExpire

public org.reactivestreams.Publisher<Boolean> clearExpire(String name)

Description copied from interface: RKeysReactive

Clear an expire timeout or expire date for object.

Specified by:

clearExpire in interface RKeysReactive

Parameters:

name - of object

Returns:

true if timeout was removed false if object does not exist or does not have an associated timeout

renamenx

public org.reactivestreams.Publisher<Boolean> renamenx(String oldName,
                                                       String newName)

Description copied from interface: RKeysReactive

Rename object with oldName to newName only if new key is not exists

Specified by:

renamenx in interface RKeysReactive

Parameters:

oldName - - old name of object

newName - - new name of object

Returns:

true if object has been renamed successfully and false otherwise

rename

public org.reactivestreams.Publisher<Void> rename(String currentName,
                                                  String newName)

Description copied from interface: RKeysReactive

Rename current object key to newName

Specified by:

rename in interface RKeysReactive

Parameters:

currentName - - current name of object

newName - - new name of object

remainTimeToLive

public org.reactivestreams.Publisher<Long> remainTimeToLive(String name)

Description copied from interface: RKeysReactive

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLive in interface RKeysReactive

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

public org.reactivestreams.Publisher<Long> touch(String... names)

Description copied from interface: RKeysReactive

Update the last access time of an object.

Specified by:

touch in interface RKeysReactive

Parameters:

names - of keys

Returns:

count of objects were touched

countExists

public org.reactivestreams.Publisher<Long> countExists(String... names)

Description copied from interface: RKeysReactive

Checks if provided keys exist

Specified by:

countExists in interface RKeysReactive

Parameters:

names - of keys

Returns:

amount of existing keys

getType

public org.reactivestreams.Publisher<RType> getType(String key)

Description copied from interface: RKeysReactive

Get Redis object type by key

Specified by:

getType in interface RKeysReactive

Parameters:

key - - name of key

Returns:

type of key

unlink

public org.reactivestreams.Publisher<Long> unlink(String... keys)

Description copied from interface: RKeysReactive

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

Requires Redis 4.0+

Specified by:

unlink in interface RKeysReactive

Parameters:

keys - of objects

Returns:

number of removed keys

count

public org.reactivestreams.Publisher<Long> count()

Description copied from interface: RKeysReactive

Returns the number of keys in the currently-selected database

Specified by:

count in interface RKeysReactive

Returns:

count of keys