org.springframework.data.redis.connection

Interface ReactiveStringCommands

All Known Subinterfaces:

ReactiveClusterStringCommands

All Known Implementing Classes:

LettuceReactiveClusterStringCommands, LettuceReactiveStringCommands

public interface ReactiveStringCommands

Redis String commands executed using reactive infrastructure.

Since:

2.0

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ReactiveStringCommands.AppendCommand APPEND command parameters.
static class	ReactiveStringCommands.BitCountCommand BITCOUNT command parameters.
static class	ReactiveStringCommands.BitOpCommand BITOP command parameters.
static class	ReactiveStringCommands.GetBitCommand GETBIT command parameters.
static class	ReactiveStringCommands.MSetCommand MSET command parameters.
static class	ReactiveStringCommands.SetBitCommand SETBIT command parameters.
static class	ReactiveStringCommands.SetCommand SET command parameters.
static class	ReactiveStringCommands.SetRangeCommand SETRANGE command parameters.

Method Summary

Modifier and Type	Method and Description
default reactor.core.publisher.Mono<Long>	append(ByteBuffer key, ByteBuffer value) Append a value to key.
reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveStringCommands.AppendCommand,Long>>	append(org.reactivestreams.Publisher<ReactiveStringCommands.AppendCommand> commands) Append a ReactiveStringCommands.AppendCommand.getValue() to the ReactiveRedisConnection.KeyCommand.getKey().
default reactor.core.publisher.Mono<Long>	bitCount(ByteBuffer key) Count the number of set bits (population counting) in value stored at key.
default reactor.core.publisher.Mono<Long>	bitCount(ByteBuffer key, long begin, long end) Count the number of set bits (population counting) of value stored at key between begin and end.
reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveStringCommands.BitCountCommand,Long>>	bitCount(org.reactivestreams.Publisher<ReactiveStringCommands.BitCountCommand> commands) Count the number of set bits (population counting) of value stored at key between begin and end.
default reactor.core.publisher.Mono<Long>	bitOp(Collection<ByteBuffer> keys, RedisStringCommands.BitOperation bitOp, ByteBuffer destination) Perform bitwise operations between strings.
reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveStringCommands.BitOpCommand,Long>>	bitOp(org.reactivestreams.Publisher<ReactiveStringCommands.BitOpCommand> commands) Perform bitwise operations between strings.
default reactor.core.publisher.Mono<ByteBuffer>	get(ByteBuffer key) Get single element stored at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveRedisConnection.KeyCommand>>	get(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> keys) Get elements one by one.
default reactor.core.publisher.Mono<Boolean>	getBit(ByteBuffer key, long offset) Get the bit value at offset of value at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.GetBitCommand>>	getBit(org.reactivestreams.Publisher<ReactiveStringCommands.GetBitCommand> commands) Get the bit value at offset of value at key.
default reactor.core.publisher.Mono<ByteBuffer>	getRange(ByteBuffer key, long begin, long end) Get a substring of value of key between begin and end.
reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveRedisConnection.RangeCommand>>	getRange(org.reactivestreams.Publisher<ReactiveRedisConnection.RangeCommand> commands) Get a substring of value of key between begin and end.
default reactor.core.publisher.Mono<ByteBuffer>	getSet(ByteBuffer key, ByteBuffer value) Set value for key and return the existing value.
reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveStringCommands.SetCommand>>	getSet(org.reactivestreams.Publisher<ReactiveStringCommands.SetCommand> commands) Set value for key and return the existing value one by one.
default reactor.core.publisher.Mono<List<ByteBuffer>>	mGet(List<ByteBuffer> keys) Get multiple values in one batch.
reactor.core.publisher.Flux<ReactiveRedisConnection.MultiValueResponse<List<ByteBuffer>,ByteBuffer>>	mGet(org.reactivestreams.Publisher<List<ByteBuffer>> keysets) Get multiple values at for keysets in batches.
default reactor.core.publisher.Mono<Boolean>	mSet(Map<ByteBuffer,ByteBuffer> keyValuePairs) Set multiple keys to multiple values using key-value pairs provided in tuple.
reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.MSetCommand>>	mSet(org.reactivestreams.Publisher<ReactiveStringCommands.MSetCommand> commands) Set multiple keys to multiple values using key-value pairs provided in commands.
default reactor.core.publisher.Mono<Boolean>	mSetNX(Map<ByteBuffer,ByteBuffer> keyValuePairs) Set multiple keys to multiple values using key-value pairs provided in keyValuePairs only if the provided key does not exist.
reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.MSetCommand>>	mSetNX(org.reactivestreams.Publisher<ReactiveStringCommands.MSetCommand> source) Set multiple keys to multiple values using key-value pairs provided in tuples only if the provided key does not exist.
default reactor.core.publisher.Mono<Boolean>	pSetEX(ByteBuffer key, ByteBuffer value, Expiration expireTimeout) Set key value pair and Expiration.
reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.SetCommand>>	pSetEX(org.reactivestreams.Publisher<ReactiveStringCommands.SetCommand> commands) Set key value pairs and Expiration.
default reactor.core.publisher.Mono<Boolean>	set(ByteBuffer key, ByteBuffer value) Set value for key.
default reactor.core.publisher.Mono<Boolean>	set(ByteBuffer key, ByteBuffer value, Expiration expiration, RedisStringCommands.SetOption option) Set value for key with expiration and options.
reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.SetCommand>>	set(org.reactivestreams.Publisher<ReactiveStringCommands.SetCommand> commands) Set each and every item separately by invoking ReactiveStringCommands.SetCommand.
default reactor.core.publisher.Mono<Boolean>	setBit(ByteBuffer key, long offset, boolean value) Sets the bit at offset in value stored at key and return the original value.
reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.SetBitCommand>>	setBit(org.reactivestreams.Publisher<ReactiveStringCommands.SetBitCommand> commands) Sets the bit at offset in value stored at key and return the original value.
default reactor.core.publisher.Mono<Boolean>	setEX(ByteBuffer key, ByteBuffer value, Expiration expireTimeout) Set key value pair and Expiration.
reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.SetCommand>>	setEX(org.reactivestreams.Publisher<ReactiveStringCommands.SetCommand> commands) Set key value pairs and Expiration.
default reactor.core.publisher.Mono<Boolean>	setNX(ByteBuffer key, ByteBuffer value) Set value for key, only if key does not exist.
reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.SetCommand>>	setNX(org.reactivestreams.Publisher<ReactiveStringCommands.SetCommand> values) Set key value pairs, only if key does not exist.
default reactor.core.publisher.Mono<Long>	setRange(ByteBuffer key, ByteBuffer value, long offset) Overwrite parts of key starting at the specified offset with given value.
reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveStringCommands.SetRangeCommand,Long>>	setRange(org.reactivestreams.Publisher<ReactiveStringCommands.SetRangeCommand> commands) Overwrite parts of ReactiveRedisConnection.KeyCommand.key starting at the specified offset with given ReactiveStringCommands.SetRangeCommand.value.
default reactor.core.publisher.Mono<Long>	strLen(ByteBuffer key) Get the length of the value stored at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>>	strLen(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> keys) Get the length of the value stored at key.

Method Detail

set

default reactor.core.publisher.Mono<Boolean> set(ByteBuffer key,
                                                 ByteBuffer value)

Set value for key.

Parameters:

key - must not be null.

value - must not be null.

Returns:

set

default reactor.core.publisher.Mono<Boolean> set(ByteBuffer key,
                                                 ByteBuffer value,
                                                 Expiration expiration,
                                                 RedisStringCommands.SetOption option)

Set value for key with expiration and options.

Parameters:

key - must not be null.

value - must not be null.

expiration - must not be null.

option - must not be null.

Returns:

set

reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.SetCommand>> set(org.reactivestreams.Publisher<ReactiveStringCommands.SetCommand> commands)

Set each and every item separately by invoking ReactiveStringCommands.SetCommand.

Parameters:

commands - must not be null.

Returns:

Flux of ReactiveRedisConnection.BooleanResponse holding the ReactiveStringCommands.SetCommand along with the command result.

get

default reactor.core.publisher.Mono<ByteBuffer> get(ByteBuffer key)

Get single element stored at key.

Parameters:

key - must not be null.

Returns:

empty ByteBuffer in case key does not exist.

get

reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveRedisConnection.KeyCommand>> get(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> keys)

Get elements one by one.

Parameters:

keys - must not be null.

Returns:

Flux of ReactiveRedisConnection.ByteBufferResponse holding the key to get along with the value retrieved.

getSet

default reactor.core.publisher.Mono<ByteBuffer> getSet(ByteBuffer key,
                                                       ByteBuffer value)

Set value for key and return the existing value.

Parameters:

key - must not be null.

value - must not be null.

Returns:

getSet

reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveStringCommands.SetCommand>> getSet(org.reactivestreams.Publisher<ReactiveStringCommands.SetCommand> commands)

Set value for key and return the existing value one by one.

Parameters:

commands - must not be null.

Returns:

Flux of ReactiveRedisConnection.ByteBufferResponse holding the ReactiveStringCommands.SetCommand along with the previously existing value.

mGet

default reactor.core.publisher.Mono<List<ByteBuffer>> mGet(List<ByteBuffer> keys)

Get multiple values in one batch.

Parameters:

keys - must not be null.

Returns:

mGet

reactor.core.publisher.Flux<ReactiveRedisConnection.MultiValueResponse<List<ByteBuffer>,ByteBuffer>> mGet(org.reactivestreams.Publisher<List<ByteBuffer>> keysets)

Get multiple values at for keysets in batches.

Parameters:

keysets - must not be null.

Returns:

setNX

default reactor.core.publisher.Mono<Boolean> setNX(ByteBuffer key,
                                                   ByteBuffer value)

Set value for key, only if key does not exist.

Parameters:

key - must not be null.

value - must not be null.

Returns:

setNX

reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.SetCommand>> setNX(org.reactivestreams.Publisher<ReactiveStringCommands.SetCommand> values)

Set key value pairs, only if key does not exist.

Parameters:

values - must not be null.

Returns:

setEX

default reactor.core.publisher.Mono<Boolean> setEX(ByteBuffer key,
                                                   ByteBuffer value,
                                                   Expiration expireTimeout)

Set key value pair and Expiration.

Parameters:

key - must not be null.

value - must not be null.

expireTimeout - must not be null.

Returns:

setEX

reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.SetCommand>> setEX(org.reactivestreams.Publisher<ReactiveStringCommands.SetCommand> commands)

Set key value pairs and Expiration.

Parameters:

commands - must not be null.

Returns:

pSetEX

default reactor.core.publisher.Mono<Boolean> pSetEX(ByteBuffer key,
                                                    ByteBuffer value,
                                                    Expiration expireTimeout)

Set key value pair and Expiration.

Parameters:

key - must not be null.

value - must not be null.

expireTimeout - must not be null.

Returns:

pSetEX

reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.SetCommand>> pSetEX(org.reactivestreams.Publisher<ReactiveStringCommands.SetCommand> commands)

Set key value pairs and Expiration.

Parameters:

commands - must not be null.

Returns:

mSet

default reactor.core.publisher.Mono<Boolean> mSet(Map<ByteBuffer,ByteBuffer> keyValuePairs)

Set multiple keys to multiple values using key-value pairs provided in tuple.

Parameters:

keyValuePairs - must not be null.

Returns:

mSet

reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.MSetCommand>> mSet(org.reactivestreams.Publisher<ReactiveStringCommands.MSetCommand> commands)

Set multiple keys to multiple values using key-value pairs provided in commands.

Parameters:

commands - must not be null.

Returns:

mSetNX

default reactor.core.publisher.Mono<Boolean> mSetNX(Map<ByteBuffer,ByteBuffer> keyValuePairs)

Set multiple keys to multiple values using key-value pairs provided in keyValuePairs only if the provided key does not exist.

Parameters:

keyValuePairs - must not be null.

Returns:

mSetNX

reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.MSetCommand>> mSetNX(org.reactivestreams.Publisher<ReactiveStringCommands.MSetCommand> source)

Set multiple keys to multiple values using key-value pairs provided in tuples only if the provided key does not exist.

Parameters:

source - must not be null.

Returns:

append

default reactor.core.publisher.Mono<Long> append(ByteBuffer key,
                                                 ByteBuffer value)

Append a value to key.

Parameters:

key - must not be null.

value - must not be null.

Returns:

append

reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveStringCommands.AppendCommand,Long>> append(org.reactivestreams.Publisher<ReactiveStringCommands.AppendCommand> commands)

Append a ReactiveStringCommands.AppendCommand.getValue() to the ReactiveRedisConnection.KeyCommand.getKey().

Parameters:

commands - must not be null.

Returns:

getRange

default reactor.core.publisher.Mono<ByteBuffer> getRange(ByteBuffer key,
                                                         long begin,
                                                         long end)

Get a substring of value of key between begin and end.

Parameters:

key - must not be null.

begin -

end -

Returns:

getRange

reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveRedisConnection.RangeCommand>> getRange(org.reactivestreams.Publisher<ReactiveRedisConnection.RangeCommand> commands)

Get a substring of value of key between begin and end.

Parameters:

commands - must not be null.

Returns:

setRange

default reactor.core.publisher.Mono<Long> setRange(ByteBuffer key,
                                                   ByteBuffer value,
                                                   long offset)

Overwrite parts of key starting at the specified offset with given value.

Parameters:

key - must not be null.

value - must not be null.

offset -

Returns:

setRange

reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveStringCommands.SetRangeCommand,Long>> setRange(org.reactivestreams.Publisher<ReactiveStringCommands.SetRangeCommand> commands)

Overwrite parts of ReactiveRedisConnection.KeyCommand.key starting at the specified offset with given ReactiveStringCommands.SetRangeCommand.value.

Parameters:

commands - must not be null.

Returns:

getBit

default reactor.core.publisher.Mono<Boolean> getBit(ByteBuffer key,
                                                    long offset)

Get the bit value at offset of value at key.

Parameters:

key - must not be null.

offset -

Returns:

getBit

reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.GetBitCommand>> getBit(org.reactivestreams.Publisher<ReactiveStringCommands.GetBitCommand> commands)

Get the bit value at offset of value at key.

Parameters:

commands - must not be null.

Returns:

setBit

default reactor.core.publisher.Mono<Boolean> setBit(ByteBuffer key,
                                                    long offset,
                                                    boolean value)

Sets the bit at offset in value stored at key and return the original value.

Parameters:

key - must not be null.

offset -

value -

Returns:

setBit

reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveStringCommands.SetBitCommand>> setBit(org.reactivestreams.Publisher<ReactiveStringCommands.SetBitCommand> commands)

Sets the bit at offset in value stored at key and return the original value.

Parameters:

commands - must not be null.

Returns:

bitCount

default reactor.core.publisher.Mono<Long> bitCount(ByteBuffer key)

Count the number of set bits (population counting) in value stored at key.

Parameters:

key - must not be null.

Returns:

bitCount

default reactor.core.publisher.Mono<Long> bitCount(ByteBuffer key,
                                                   long begin,
                                                   long end)

Count the number of set bits (population counting) of value stored at key between begin and end.

Parameters:

key - must not be null.

begin -

end -

Returns:

bitCount

reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveStringCommands.BitCountCommand,Long>> bitCount(org.reactivestreams.Publisher<ReactiveStringCommands.BitCountCommand> commands)

Count the number of set bits (population counting) of value stored at key between begin and end.

Parameters:

commands - must not be null.

Returns:

bitOp

default reactor.core.publisher.Mono<Long> bitOp(Collection<ByteBuffer> keys,
                                                RedisStringCommands.BitOperation bitOp,
                                                ByteBuffer destination)

Perform bitwise operations between strings.

Parameters:

keys - must not be null.

bitOp - must not be null.

destination - must not be null.

Returns:

bitOp

reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveStringCommands.BitOpCommand,Long>> bitOp(org.reactivestreams.Publisher<ReactiveStringCommands.BitOpCommand> commands)

Perform bitwise operations between strings.

Parameters:

commands - must not be null.

Returns:

strLen

default reactor.core.publisher.Mono<Long> strLen(ByteBuffer key)

Get the length of the value stored at key.

Parameters:

key - must not be null.

Returns:

strLen

reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>> strLen(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> keys)

Get the length of the value stored at key.

Parameters:

keys - must not be null.

Returns: