Package io.quarkus.redis.datasource.set

Interface ReactiveSetCommands<K,V>

Type Parameters:

K - the type of the key

V - the type of the value stored in the sets

All Superinterfaces:

ReactiveRedisCommands

All Known Implementing Classes:

ReactiveSetCommandsImpl

public interface ReactiveSetCommands<K,V>
extends ReactiveRedisCommands

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

A set is a set of members of type V.

Method Summary

Modifier and Type	Method	Description
io.smallrye.mutiny.Uni<Integer>	sadd(K key, V... values)	Execute the command SADD.
io.smallrye.mutiny.Uni<Long>	scard(K key)	Execute the command SCARD.
io.smallrye.mutiny.Uni<Set<V>>	sdiff(K... keys)	Execute the command SDIFF.
io.smallrye.mutiny.Uni<Long>	sdiffstore(K destination, K... keys)	Execute the command SDIFFSTORE.
io.smallrye.mutiny.Uni<Set<V>>	sinter(K... keys)	Execute the command SINTER.
io.smallrye.mutiny.Uni<Long>	sintercard(int limit, K... keys)	Execute the command SINTERCARD.
io.smallrye.mutiny.Uni<Long>	sintercard(K... keys)	Execute the command SINTERCARD.
io.smallrye.mutiny.Uni<Long>	sinterstore(K destination, K... keys)	Execute the command SINTERSTORE.
io.smallrye.mutiny.Uni<Boolean>	sismember(K key, V member)	Execute the command SISMEMBER.
io.smallrye.mutiny.Uni<Set<V>>	smembers(K key)	Execute the command SMEMBERS.
io.smallrye.mutiny.Uni<List<Boolean>>	smismember(K key, V... members)	Execute the command SMISMEMBER.
io.smallrye.mutiny.Uni<Boolean>	smove(K source, K destination, V member)	Execute the command SMOVE.
io.smallrye.mutiny.Uni<List<V>>	sort(K key)	Execute the command SORT.
io.smallrye.mutiny.Uni<List<V>>	sort(K key, SortArgs sortArguments)	Execute the command SORT.
io.smallrye.mutiny.Uni<Long>	sortAndStore(K key, K destination)	Execute the command SORT with the STORE option.
io.smallrye.mutiny.Uni<Long>	sortAndStore(K key, K destination, SortArgs sortArguments)	Execute the command SORT with the STORE option.
io.smallrye.mutiny.Uni<V>	spop(K key)	Execute the command SPOP.
io.smallrye.mutiny.Uni<Set<V>>	spop(K key, int count)	Execute the command SPOP.
io.smallrye.mutiny.Uni<V>	srandmember(K key)	Execute the command SRANDMEMBER.
io.smallrye.mutiny.Uni<List<V>>	srandmember(K key, int count)	Execute the command SRANDMEMBER.
io.smallrye.mutiny.Uni<Integer>	srem(K key, V... members)	Execute the command SREM.
ReactiveSScanCursor<V>	sscan(K key)	Execute the command SSCAN.
ReactiveSScanCursor<V>	sscan(K key, ScanArgs scanArgs)	Execute the command SSCAN.
io.smallrye.mutiny.Uni<Set<V>>	sunion(K... keys)	Execute the command SUNION.
io.smallrye.mutiny.Uni<Long>	sunionstore(K destination, K... keys)	Execute the command SUNIONSTORE.

Methods inherited from interface io.quarkus.redis.datasource.ReactiveRedisCommands

getDataSource

Method Detail

sadd

io.smallrye.mutiny.Uni<Integer> sadd(K key,
                                     V... values)

Execute the command SADD. Summary: Add one or more members to a set Group: set Requires Redis 1.0.0

Parameters:

key - the key

values - the values

Returns:

the number of elements that were added to the set, not including all the elements already present in the set.

scard

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

Execute the command SCARD. Summary: Get the number of members in a set Group: set Requires Redis 1.0.0

Parameters:

key - the key

Returns:

the cardinality (number of elements) of the set, or 0 key does not exist.

sdiff

io.smallrye.mutiny.Uni<Set<V>> sdiff(K... keys)

Execute the command SDIFF. Summary: Subtract multiple sets Group: set Requires Redis 1.0.0

Parameters:

keys - the keys

Returns:

list with members of the resulting set.

sdiffstore

io.smallrye.mutiny.Uni<Long> sdiffstore(K destination,
                                        K... keys)

Execute the command SDIFFSTORE. Summary: Subtract multiple sets and store the resulting set in a key Group: set Requires Redis 1.0.0

Parameters:

destination - the key

keys - the keys

Returns:

the number of elements in the resulting set.

sinter

io.smallrye.mutiny.Uni<Set<V>> sinter(K... keys)

Execute the command SINTER. Summary: Intersect multiple sets Group: set Requires Redis 1.0.0

Parameters:

keys - the keys

Returns:

list with members of the resulting set.

sintercard

io.smallrye.mutiny.Uni<Long> sintercard(K... keys)

Execute the command SINTERCARD. Summary: Intersect multiple sets and return the cardinality of the result Group: set Requires Redis 7.0.0

Parameters:

keys - the keys

Returns:

the number of elements in the resulting intersection.

sintercard

io.smallrye.mutiny.Uni<Long> sintercard(int limit,
                                        K... keys)

Execute the command SINTERCARD. Summary: Intersect multiple sets and return the cardinality of the result Group: set Requires Redis 7.0.0

Parameters:

limit - When provided with the optional LIMIT argument (which defaults to 0 and means unlimited), if the intersection cardinality reaches limit partway through the computation, the algorithm will exit and yield limit as the cardinality.

keys - the keys

Returns:

the number of elements in the resulting intersection.

sinterstore

io.smallrye.mutiny.Uni<Long> sinterstore(K destination,
                                         K... keys)

Execute the command SINTERSTORE. Summary: Intersect multiple sets and store the resulting set in a key Group: set Requires Redis 1.0.0

Parameters:

destination - the key

keys - the keys

Returns:

the number of elements in the resulting set.

sismember

io.smallrye.mutiny.Uni<Boolean> sismember(K key,
                                          V member)

Execute the command SISMEMBER. Summary: Determine if a given value is a member of a set Group: set Requires Redis 1.0.0

Parameters:

key - the key

member - the member to check

Returns:

true the element is a member of the set. false the element is not a member of the set, or if key does not exist.

smembers

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

Execute the command SMEMBERS. Summary: Get all the members in a set Group: set Requires Redis 1.0.0

Parameters:

key - the key

Returns:

all elements of the set.

smismember

io.smallrye.mutiny.Uni<List<Boolean>> smismember(K key,
                                                 V... members)

Execute the command SMISMEMBER. Summary: Returns the membership associated with the given elements for a set Group: set Requires Redis 6.2.0

Parameters:

key - the key

members - the members to check

Returns:

list representing the membership of the given elements, in the same order as they are requested.

smove

io.smallrye.mutiny.Uni<Boolean> smove(K source,
                                      K destination,
                                      V member)

Execute the command SMOVE. Summary: Move a member from one set to another Group: set Requires Redis 1.0.0

Parameters:

source - the key

destination - the key

member - the member to move

Returns:

true the element is moved. false the element is not a member of source and no operation was performed.

spop

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

Execute the command SPOP. Summary: Remove and return one or multiple random members from a set Group: set Requires Redis 1.0.0

Parameters:

key - the key

Returns:

the removed member, or null when key does not exist.

spop

io.smallrye.mutiny.Uni<Set<V>> spop(K key,
                                    int count)

Execute the command SPOP. Summary: Remove and return one or multiple random members from a set Group: set Requires Redis 1.0.0

Parameters:

key - the key

Returns:

the removed members, or an empty array when key does not exist.

srandmember

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

Execute the command SRANDMEMBER. Summary: Get one or multiple random members from a set Group: set Requires Redis 1.0.0

Parameters:

key - the key

Returns:

the randomly selected element, or null when key does not exist.

srandmember

io.smallrye.mutiny.Uni<List<V>> srandmember(K key,
                                            int count)

Execute the command SRANDMEMBER. Summary: Get one or multiple random members from a set Group: set Requires Redis 1.0.0

Parameters:

key - the key

count - the number of elements to pick

Returns:

an array of elements, or an empty array when key does not exist.

srem

io.smallrye.mutiny.Uni<Integer> srem(K key,
                                     V... members)

Execute the command SREM. Summary: Remove one or more members from a set Group: set Requires Redis 1.0.0

Parameters:

key - the key

Returns:

the number of members that were removed from the set, not including non-existing members.

sunion

io.smallrye.mutiny.Uni<Set<V>> sunion(K... keys)

Execute the command SUNION. Summary: Add multiple sets Group: set Requires Redis 1.0.0

Parameters:

keys - the keys

Returns:

list with members of the resulting set.

sunionstore

io.smallrye.mutiny.Uni<Long> sunionstore(K destination,
                                         K... keys)

Execute the command SUNIONSTORE. Summary: Add multiple sets and store the resulting set in a key Group: set Requires Redis 1.0.0

Parameters:

destination - the destination key

keys - the keys

Returns:

the number of elements in the resulting set.

sscan

ReactiveSScanCursor<V> sscan(K key)

Execute the command SSCAN. Summary: Incrementally iterate Set elements Group: set Requires Redis 2.8.0

Parameters:

key - the key

Returns:

the cursor

sscan

ReactiveSScanCursor<V> sscan(K key,
                             ScanArgs scanArgs)

Execute the command SSCAN. Summary: Incrementally iterate Set elements Group: set Requires Redis 2.8.0

Parameters:

key - the key

scanArgs - the extra parameters

Returns:

the cursor

sort

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

Execute the command SORT. Summary: Sort the elements in a list, set or sorted set Group: generic Requires Redis 1.0.0

Returns:

the list of sorted elements.

sort

io.smallrye.mutiny.Uni<List<V>> sort(K key,
                                     SortArgs sortArguments)

Execute the command SORT. Summary: Sort the elements in a list, set or sorted set Group: generic Requires Redis 1.0.0

Parameters:

key - the key

sortArguments - the SORT command extra-arguments

Returns:

the list of sorted elements.

sortAndStore

io.smallrye.mutiny.Uni<Long> sortAndStore(K key,
                                          K destination,
                                          SortArgs sortArguments)

Execute the command SORT with the STORE option. Summary: Sort the elements in a list, set or sorted set Group: generic Requires Redis 1.0.0

Parameters:

sortArguments - the SORT command extra-arguments

Returns:

the number of sorted elements in the destination list.

sortAndStore

io.smallrye.mutiny.Uni<Long> sortAndStore(K key,
                                          K destination)

Execute the command SORT with the STORE option. Summary: Sort the elements in a list, set or sorted set Group: generic Requires Redis 1.0.0

Returns:

the number of sorted elements in the destination list.