Package io.quarkus.redis.datasource.string

Interface ReactiveStringCommands<K,V>

Type Parameters:

K - the type of the key

V - the type of the value

All Known Implementing Classes:

ReactiveStringCommandsImpl

public interface ReactiveStringCommands<K,V>

Allows executing commands from the string group. See the string command list for further information about these commands.

This group can be used with value of type String, or a type which will be automatically serialized/deserialized with a codec.

Method Summary

Modifier and Type	Method	Description
io.smallrye.mutiny.Uni<Long>	append(K key, V value)	Execute the command APPEND.
io.smallrye.mutiny.Uni<Long>	decr(K key)	Execute the command DECR.
io.smallrye.mutiny.Uni<Long>	decrby(K key, long amount)	Execute the command DECRBY.
io.smallrye.mutiny.Uni<V>	get(K key)	Execute the command GET.
io.smallrye.mutiny.Uni<V>	getdel(K key)	Execute the command GETDEL.
io.smallrye.mutiny.Uni<V>	getex(K key, GetExArgs args)	Execute the command GETEX.
io.smallrye.mutiny.Uni<String>	getrange(K key, long start, long end)	Execute the command GETRANGE.
io.smallrye.mutiny.Uni<V>	getset(K key, V value)	Deprecated. See https://redis.io/commands/getset
io.smallrye.mutiny.Uni<Long>	incr(K key)	Execute the command INCR.
io.smallrye.mutiny.Uni<Long>	incrby(K key, long amount)	Execute the command INCRBY.
io.smallrye.mutiny.Uni<Double>	incrbyfloat(K key, double amount)	Execute the command INCRBYFLOAT.
io.smallrye.mutiny.Uni<String>	lcs(K key1, K key2)	Execute the command LCS.
io.smallrye.mutiny.Uni<Long>	lcsLength(K key1, K key2)	Execute the command LCS.
io.smallrye.mutiny.Uni<Map<K,V>>	mget(K... keys)	Execute the command MGET.
io.smallrye.mutiny.Uni<Void>	mset(Map<K,V> map)	Execute the command MSET.
io.smallrye.mutiny.Uni<Boolean>	msetnx(Map<K,V> map)	Execute the command MSETNX.
io.smallrye.mutiny.Uni<Void>	psetex(K key, long milliseconds, V value)	Execute the command PSETEX.
io.smallrye.mutiny.Uni<Void>	set(K key, V value)	Execute the command SET.
io.smallrye.mutiny.Uni<Void>	set(K key, V value, SetArgs setArgs)	Execute the command SET.
io.smallrye.mutiny.Uni<Void>	setex(K key, long seconds, V value)	Execute the command SETEX.
io.smallrye.mutiny.Uni<V>	setGet(K key, V value)	Execute the command SET.
io.smallrye.mutiny.Uni<V>	setGet(K key, V value, SetArgs setArgs)	Execute the command SET.
io.smallrye.mutiny.Uni<Boolean>	setnx(K key, V value)	Execute the command SETNX.
io.smallrye.mutiny.Uni<Long>	setrange(K key, long offset, V value)	Execute the command SETRANGE.
io.smallrye.mutiny.Uni<Long>	strlen(K key)	Execute the command STRLEN.

Method Detail

append

io.smallrye.mutiny.Uni<Long> append(K key,
                                    V value)

Execute the command APPEND. Summary: Append a value to a key Group: string Requires Redis 2.0.0

Parameters:

key - the key

value - the value

Returns:

the length of the string after the append operation.

decr

io.smallrye.mutiny.Uni<Long> decr(K key)

Execute the command DECR. Summary: Decrement the integer value of a key by one Group: string Requires Redis 1.0.0

Parameters:

key - the key

Returns:

the value of key after the decrement

decrby

io.smallrye.mutiny.Uni<Long> decrby(K key,
                                    long amount)

Execute the command DECRBY. Summary: Decrement the integer value of a key by the given number Group: string Requires Redis 1.0.0

Parameters:

key - the key

amount - the amount, can be negative

Returns:

the value of key after the decrement

get

io.smallrye.mutiny.Uni<V> get(K key)

Execute the command GET. Summary: Get the value of a key Group: string Requires Redis 1.0.0

Parameters:

key - the key

Returns:

the value of key, or null when key does not exist.

getdel

io.smallrye.mutiny.Uni<V> getdel(K key)

Execute the command GETDEL. Summary: Get the value of a key and delete the key Group: string Requires Redis 6.2.0

Parameters:

key - the key

Returns:

the value of key, null when key does not exist, or an error if the key's value type isn't a string.

getex

io.smallrye.mutiny.Uni<V> getex(K key,
                                GetExArgs args)

Execute the command GETEX. Summary: Get the value of a key and optionally set its expiration Group: string Requires Redis 6.2.0

Parameters:

key - the key

args - the getex command extra-arguments

Returns:

the value of key, or null when key does not exist.

getrange

io.smallrye.mutiny.Uni<String> getrange(K key,
                                        long start,
                                        long end)

Execute the command GETRANGE. Summary: Get a substring of the string stored at a key Group: string Requires Redis 2.4.0

Parameters:

key - the key

start - the start offset

end - the end offset

Returns:

the sub-string

getset

io.smallrye.mutiny.Uni<V> getset(K key,
                                 V value)

Deprecated.

See https://redis.io/commands/getset

Execute the command GETSET. Summary: Set the string value of a key and return its old value Group: string Requires Redis 1.0.0

Parameters:

key - the key

value - the value

Returns:

the old value stored at key, or null when key did not exist.

incr

io.smallrye.mutiny.Uni<Long> incr(K key)

Execute the command INCR. Summary: Increment the integer value of a key by one Group: string Requires Redis 1.0.0

Parameters:

key - the key

Returns:

the value of key after the increment

incrby

io.smallrye.mutiny.Uni<Long> incrby(K key,
                                    long amount)

Execute the command INCRBY. Summary: Increment the integer value of a key by the given amount Group: string Requires Redis 1.0.0

Parameters:

key - the key

amount - the amount, can be negative

Returns:

the value of key after the increment

incrbyfloat

io.smallrye.mutiny.Uni<Double> incrbyfloat(K key,
                                           double amount)

Execute the command INCRBYFLOAT. Summary: Increment the float value of a key by the given amount Group: string Requires Redis 2.6.0

Parameters:

key - the key

amount - the amount, can be negative

Returns:

the value of key after the increment.

lcs

io.smallrye.mutiny.Uni<String> lcs(K key1,
                                   K key2)

Execute the command LCS. Summary: Find longest common substring Group: string Requires Redis 7.0.0

Parameters:

key1 - the key

key2 - the key

Returns:

the string representing the longest common substring is returned.

lcsLength

io.smallrye.mutiny.Uni<Long> lcsLength(K key1,
                                       K key2)

Execute the command LCS. Summary: Find longest common substring and return the length (using LEN) Group: string Requires Redis 7.0.0

Parameters:

key1 - the key

key2 - the key

Returns:

the length of the longest common substring.

mget

io.smallrye.mutiny.Uni<Map<K,V>> mget(K... keys)

Execute the command MGET. Summary: Get the values of all the given keys Group: string Requires Redis 1.0.0

Parameters:

keys - the keys

Returns:

list of values at the specified keys.

mset

io.smallrye.mutiny.Uni<Void> mset(Map<K,V> map)

Execute the command MSET. Summary: Set multiple keys to multiple values Group: string Requires Redis 1.0.1

Parameters:

map - the key/value map containing the items to store

Returns:

a Uni producing a null item on success, a failure otherwise

msetnx

io.smallrye.mutiny.Uni<Boolean> msetnx(Map<K,V> map)

Execute the command MSETNX. Summary: Set multiple keys to multiple values, only if none of the keys exist Group: string Requires Redis 1.0.1

Parameters:

map - the key/value map containing the items to store

Returns:

true the all the keys were set. false no key was set (at least one key already existed).

psetex

io.smallrye.mutiny.Uni<Void> psetex(K key,
                                    long milliseconds,
                                    V value)

Execute the command PSETEX. Summary: Set the value and expiration in milliseconds of a key Group: string Requires Redis 2.6.0

Parameters:

key - the key

milliseconds - the duration in ms

value - the value

Returns:

a Uni producing a null item on success, a failure otherwise

set

io.smallrye.mutiny.Uni<Void> set(K key,
                                 V value)

Execute the command SET. Summary: Set the string value of a key Group: string Requires Redis 1.0.0

Parameters:

key - the key

value - the value

Returns:

a Uni producing a null item on success, a failure otherwise

set

io.smallrye.mutiny.Uni<Void> set(K key,
                                 V value,
                                 SetArgs setArgs)

Execute the command SET. Summary: Set the string value of a key Group: string Requires Redis 1.0.0

Parameters:

key - the key

value - the value

setArgs - the set command extra-arguments

Returns:

a Uni producing a null item on success, a failure otherwise

setGet

io.smallrye.mutiny.Uni<V> setGet(K key,
                                 V value)

Execute the command SET. Summary: Set the string value of a key, and return the previous value Group: string Requires Redis 1.0.0

Parameters:

key - the key

value - the value

Returns:

the old value, null if not present

setGet

io.smallrye.mutiny.Uni<V> setGet(K key,
                                 V value,
                                 SetArgs setArgs)

Execute the command SET. Summary: Set the string value of a key, and return the previous value Group: string Requires Redis 1.0.0

Parameters:

key - the key

value - the value

setArgs - the set command extra-arguments

Returns:

the old value, null if not present

setex

io.smallrye.mutiny.Uni<Void> setex(K key,
                                   long seconds,
                                   V value)

Execute the command SETEX. Summary: Set the value and expiration of a key Group: string Requires Redis 2.0.0

Parameters:

key - the key

value - the value

setnx

io.smallrye.mutiny.Uni<Boolean> setnx(K key,
                                      V value)

Execute the command SETNX. Summary: Set the value of a key, only if the key does not exist Group: string Requires Redis 1.0.0

Parameters:

key - the key

value - the value

Returns:

true the key was set false the key was not set

setrange

io.smallrye.mutiny.Uni<Long> setrange(K key,
                                      long offset,
                                      V value)

Execute the command SETRANGE. Summary: Overwrite part of a string at key starting at the specified offset Group: string Requires Redis 2.2.0

Parameters:

key - the key

value - the value

Returns:

the length of the string after it was modified by the command.

strlen

io.smallrye.mutiny.Uni<Long> strlen(K key)

Execute the command STRLEN. Summary: Get the length of the value stored in a key Group: string Requires Redis 2.2.0

Parameters:

key - the key

Returns:

the length of the string at key, or 0 when key does not exist.