org.springframework.data.redis.core

Interface ReactiveRedisOperations<K,V>

All Known Implementing Classes:

ReactiveRedisTemplate

public interface ReactiveRedisOperations<K,V>

Interface that specified a basic set of Redis operations, implemented by ReactiveRedisTemplate. Not often used but a useful option for extensibility and testability (as it can be easily mocked or stubbed).

Since:

2.0

Author:

Mark Paluch, Christoph Strobl

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Long>	delete(K... key) Delete given key.
reactor.core.publisher.Mono<Long>	delete(org.reactivestreams.Publisher<K> keys) Delete given keys.
<T> reactor.core.publisher.Flux<T>	execute(ReactiveRedisCallback<T> action) Executes the given action within a Redis connection.
default <T> reactor.core.publisher.Flux<T>	execute(RedisScript<T> script) Executes the given RedisScript.
default <T> reactor.core.publisher.Flux<T>	execute(RedisScript<T> script, List<K> keys) Executes the given RedisScript.
<T> reactor.core.publisher.Flux<T>	execute(RedisScript<T> script, List<K> keys, List<?> args) Executes the given RedisScript
<T> reactor.core.publisher.Flux<T>	execute(RedisScript<T> script, List<K> keys, List<?> args, RedisElementWriter<?> argsWriter, RedisElementReader<T> resultReader) Executes the given RedisScript, using the provided RedisSerializers to serialize the script arguments and result.
reactor.core.publisher.Mono<Boolean>	expire(K key, Duration timeout) Set time to live for given key.
reactor.core.publisher.Mono<Boolean>	expireAt(K key, Instant expireAt) Set the expiration for given key as a expireAt timestamp.
reactor.core.publisher.Mono<Duration>	getExpire(K key) Get the time to live for key.
RedisSerializationContext<K,V>	getSerializationContext()
reactor.core.publisher.Mono<Boolean>	hasKey(K key) Determine if given key exists.
reactor.core.publisher.Flux<K>	keys(K pattern) Find all keys matching the given pattern.
reactor.core.publisher.Mono<Boolean>	move(K key, int dbIndex) Move given key to database with index.
ReactiveGeoOperations<K,V>	opsForGeo() Returns geospatial specific operations interface.
<K,V> ReactiveGeoOperations<K,V>	opsForGeo(RedisSerializationContext<K,V> serializationContext) Returns geospatial specific operations interface.
<HK,HV> ReactiveHashOperations<K,HK,HV>	opsForHash() Returns the operations performed on hash values.
<K,HK,HV> ReactiveHashOperations<K,HK,HV>	opsForHash(RedisSerializationContext<K,?> serializationContext) Returns the operations performed on hash values given a RedisSerializationContext.
ReactiveHyperLogLogOperations<K,V>	opsForHyperLogLog() Returns the operations performed on multisets using HyperLogLog.
<K,V> ReactiveHyperLogLogOperations<K,V>	opsForHyperLogLog(RedisSerializationContext<K,V> serializationContext) Returns the operations performed on multisets using HyperLogLog given a RedisSerializationContext.
ReactiveListOperations<K,V>	opsForList() Returns the operations performed on list values.
<K,V> ReactiveListOperations<K,V>	opsForList(RedisSerializationContext<K,V> serializationContext) Returns the operations performed on list values given a RedisSerializationContext.
ReactiveSetOperations<K,V>	opsForSet() Returns the operations performed on set values.
<K,V> ReactiveSetOperations<K,V>	opsForSet(RedisSerializationContext<K,V> serializationContext) Returns the operations performed on set values given a RedisSerializationContext.
ReactiveValueOperations<K,V>	opsForValue() Returns the operations performed on simple values (or Strings in Redis terminology).
<K,V> ReactiveValueOperations<K,V>	opsForValue(RedisSerializationContext<K,V> serializationContext) Returns the operations performed on simple values (or Strings in Redis terminology) given a RedisSerializationContext.
ReactiveZSetOperations<K,V>	opsForZSet() Returns the operations performed on zset values (also known as sorted sets).
<K,V> ReactiveZSetOperations<K,V>	opsForZSet(RedisSerializationContext<K,V> serializationContext) Returns the operations performed on zset values (also known as sorted sets) given a RedisSerializationContext.
reactor.core.publisher.Mono<Boolean>	persist(K key) Remove the expiration from given key.
reactor.core.publisher.Mono<K>	randomKey() Return a random key from the keyspace.
reactor.core.publisher.Mono<Boolean>	rename(K oldKey, K newKey) Rename key oldKey to newKey.
reactor.core.publisher.Mono<Boolean>	renameIfAbsent(K oldKey, K newKey) Rename key oleName to newKey only if newKey does not exist.
reactor.core.publisher.Mono<DataType>	type(K key) Determine the type stored at key.

Method Detail

execute

<T> reactor.core.publisher.Flux<T> execute(ReactiveRedisCallback<T> action)

Executes the given action within a Redis connection. Application exceptions thrown by the action object get propagated to the caller (can only be unchecked) whenever possible. Redis exceptions are transformed into appropriate DAO ones. Allows for returning a result object, that is a domain object or a collection of domain objects. Performs automatic serialization/deserialization for the given objects to and from binary data suitable for the Redis storage. Note: Callback code is not supposed to handle transactions itself! Use an appropriate transaction manager. Generally, callback code must not touch any Connection lifecycle methods, like close, to let the template do its work.

Type Parameters:

T - return type

Parameters:

action - callback object that specifies the Redis action

Returns:

a result object returned by the action or Flux.empty().

hasKey

reactor.core.publisher.Mono<Boolean> hasKey(K key)

Determine if given key exists.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: EXISTS

type

reactor.core.publisher.Mono<DataType> type(K key)

Determine the type stored at key.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: TYPE

keys

reactor.core.publisher.Flux<K> keys(K pattern)

Find all keys matching the given pattern.

Parameters:

pattern - must not be null.

Returns:

See Also:

Redis Documentation: KEYS

randomKey

reactor.core.publisher.Mono<K> randomKey()

Return a random key from the keyspace.

Returns:

See Also:

Redis Documentation: RANDOMKEY

rename

reactor.core.publisher.Mono<Boolean> rename(K oldKey,
                                            K newKey)

Rename key oldKey to newKey.

Parameters:

oldKey - must not be null.

newKey - must not be null.

See Also:

Redis Documentation: RENAME

renameIfAbsent

reactor.core.publisher.Mono<Boolean> renameIfAbsent(K oldKey,
                                                    K newKey)

Rename key oleName to newKey only if newKey does not exist.

Parameters:

oldKey - must not be null.

newKey - must not be null.

Returns:

See Also:

Redis Documentation: RENAMENX

delete

reactor.core.publisher.Mono<Long> delete(K... key)

Delete given key.

Parameters:

key - must not be null.

Returns:

The number of keys that were removed.

See Also:

Redis Documentation: DEL

delete

reactor.core.publisher.Mono<Long> delete(org.reactivestreams.Publisher<K> keys)

Delete given keys.

Parameters:

keys - must not be null.

Returns:

The number of keys that were removed.

See Also:

Redis Documentation: DEL

expire

reactor.core.publisher.Mono<Boolean> expire(K key,
                                            Duration timeout)

Set time to live for given key.

Parameters:

key - must not be null.

timeout - must not be null.

Returns:

expireAt

reactor.core.publisher.Mono<Boolean> expireAt(K key,
                                              Instant expireAt)

Set the expiration for given key as a expireAt timestamp.

Parameters:

key - must not be null.

expireAt - must not be null.

Returns:

persist

reactor.core.publisher.Mono<Boolean> persist(K key)

Remove the expiration from given key.

Parameters:

key - must not be null.

Returns:

See Also:

Redis Documentation: PERSIST

move

reactor.core.publisher.Mono<Boolean> move(K key,
                                          int dbIndex)

Move given key to database with index.

Parameters:

key - must not be null.

dbIndex -

Returns:

See Also:

Redis Documentation: MOVE

getExpire

reactor.core.publisher.Mono<Duration> getExpire(K key)

Get the time to live for key.

Parameters:

key - must not be null.

Returns:

the Duration of the associated key. Duration.ZERO if no timeout associated or empty Mono if the key does not exist.

See Also:

Redis Documentation: PTTL

execute

default <T> reactor.core.publisher.Flux<T> execute(RedisScript<T> script)

Executes the given RedisScript.

Parameters:

script - must not be null.

Returns:

result value of the script Flux.empty() if RedisScript.getResultType() is null, likely indicating a throw-away status reply (i.e. "OK").

execute

default <T> reactor.core.publisher.Flux<T> execute(RedisScript<T> script,
                                                   List<K> keys)

Executes the given RedisScript.

Parameters:

script - must not be null.

keys - must not be null.

Returns:

result value of the script Flux.empty() if RedisScript.getResultType() is null, likely indicating a throw-away status reply (i.e. "OK").

execute

<T> reactor.core.publisher.Flux<T> execute(RedisScript<T> script,
                                           List<K> keys,
                                           List<?> args)

Executes the given RedisScript

Parameters:

script - The script to execute. Must not be null.

keys - keys that need to be passed to the script. Must not be null.

args - args that need to be passed to the script. Must not be null.

Returns:

result value of the script Flux.empty() if RedisScript.getResultType() is null, likely indicating a throw-away status reply (i.e. "OK").

execute

<T> reactor.core.publisher.Flux<T> execute(RedisScript<T> script,
                                           List<K> keys,
                                           List<?> args,
                                           RedisElementWriter<?> argsWriter,
                                           RedisElementReader<T> resultReader)

Executes the given RedisScript, using the provided RedisSerializers to serialize the script arguments and result.

Parameters:

script - The script to execute

argsWriter - The RedisElementWriter to use for serializing args

resultReader - The RedisElementReader to use for serializing the script return value

keys - keys that need to be passed to the script.

args - args that need to be passed to the script.

Returns:

result value of the script Flux.empty() if RedisScript.getResultType() is null, likely indicating a throw-away status reply (i.e. "OK").

opsForGeo

ReactiveGeoOperations<K,V> opsForGeo()

Returns geospatial specific operations interface.

Returns:

geospatial specific operations.

opsForGeo

<K,V> ReactiveGeoOperations<K,V> opsForGeo(RedisSerializationContext<K,V> serializationContext)

Returns geospatial specific operations interface.

Parameters:

serializationContext - serializers to be used with the returned operations, must not be null.

Returns:

geospatial specific operations.

opsForHash

<HK,HV> ReactiveHashOperations<K,HK,HV> opsForHash()

Returns the operations performed on hash values.

Type Parameters:

HK - hash key (or field) type.

HV - hash value type.

Returns:

hash operations.

opsForHash

<K,HK,HV> ReactiveHashOperations<K,HK,HV> opsForHash(RedisSerializationContext<K,?> serializationContext)

Returns the operations performed on hash values given a RedisSerializationContext.

Type Parameters:

HK - hash key (or field) type.

HV - hash value type.

Parameters:

serializationContext - serializers to be used with the returned operations, must not be null.

Returns:

hash operations.

opsForHyperLogLog

ReactiveHyperLogLogOperations<K,V> opsForHyperLogLog()

Returns the operations performed on multisets using HyperLogLog.

Returns:

never null.

opsForHyperLogLog

<K,V> ReactiveHyperLogLogOperations<K,V> opsForHyperLogLog(RedisSerializationContext<K,V> serializationContext)

Returns the operations performed on multisets using HyperLogLog given a RedisSerializationContext.

Parameters:

serializationContext - serializers to be used with the returned operations, must not be null.

Returns:

never null.

opsForList

ReactiveListOperations<K,V> opsForList()

Returns the operations performed on list values.

Returns:

list operations.

opsForList

<K,V> ReactiveListOperations<K,V> opsForList(RedisSerializationContext<K,V> serializationContext)

Returns the operations performed on list values given a RedisSerializationContext.

Parameters:

serializationContext - serializers to be used with the returned operations, must not be null.

Returns:

list operations.

opsForSet

ReactiveSetOperations<K,V> opsForSet()

Returns the operations performed on set values.

Returns:

set operations.

opsForSet

<K,V> ReactiveSetOperations<K,V> opsForSet(RedisSerializationContext<K,V> serializationContext)

Returns the operations performed on set values given a RedisSerializationContext.

Parameters:

serializationContext - serializers to be used with the returned operations, must not be null.

Returns:

set operations.

opsForValue

ReactiveValueOperations<K,V> opsForValue()

Returns the operations performed on simple values (or Strings in Redis terminology).

Returns:

value operations

opsForValue

<K,V> ReactiveValueOperations<K,V> opsForValue(RedisSerializationContext<K,V> serializationContext)

Returns the operations performed on simple values (or Strings in Redis terminology) given a RedisSerializationContext.

Parameters:

serializationContext - serializers to be used with the returned operations, must not be null.

Returns:

value operations.

opsForZSet

ReactiveZSetOperations<K,V> opsForZSet()

Returns the operations performed on zset values (also known as sorted sets).

Returns:

zset operations.

opsForZSet

<K,V> ReactiveZSetOperations<K,V> opsForZSet(RedisSerializationContext<K,V> serializationContext)

Returns the operations performed on zset values (also known as sorted sets) given a RedisSerializationContext.

Parameters:

serializationContext - serializers to be used with the returned operations, must not be null.

Returns:

zset operations.

getSerializationContext

RedisSerializationContext<K,V> getSerializationContext()

Returns:

the RedisSerializationContext.