Interface ReactiveZSetOperations<K,V>

@NullUnmarked
public interface ReactiveZSetOperations<K,V>

Reactive Redis operations for Sorted (ZSet) Commands.

Streams of methods returning Mono<K> or Flux<M> are terminated with InvalidDataAccessApiUsageException when RedisElementReader.read(ByteBuffer) returns null for a particular element as Reactive Streams prohibit the usage of null values.

Since:

2.0

Author:

Mark Paluch, Christoph Strobl, Andrey Shlykov

See Also:

• Redis Documentation: Sorted Set Commands

Method Summary

Modifier and Type	Method	Description
Mono<Boolean>	add(@NonNull K key, @NonNull V value, double score)	Add value to a sorted set at key, or update its score if it already exists.
Mono<Long>	addAll(@NonNull K key, @NonNull Collection<? extends @NonNull ZSetOperations.TypedTuple<V>> tuples)	Add tuples to a sorted set at key, or update their score if it already exists.
Mono<Long>	count(@NonNull K key, @NonNull Range<Double> range)	Count number of elements within sorted set with scores between min and max.
Mono<Boolean>	delete(@NonNull K key)	Removes the given key.
default Flux<V>	difference(@NonNull K key, @NonNull K otherKey)	Diff sorted sets.
Flux<V>	difference(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys)	Diff sorted sets.
default Mono<Long>	differenceAndStore(@NonNull K key, @NonNull K otherKey, @NonNull K destKey)	Diff sorted sets and store result in destination destKey.
Mono<Long>	differenceAndStore(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys, @NonNull K destKey)	Diff sorted sets and store result in destination destKey.
default Flux<ZSetOperations.TypedTuple<V>>	differenceWithScores(@NonNull K key, @NonNull K otherKey)	Diff sorted sets.
Flux<ZSetOperations.TypedTuple<V>>	differenceWithScores(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys)	Diff sorted sets.
Flux<V>	distinctRandomMembers(@NonNull K key, long count)	Get count distinct random elements from set at key.
Flux<ZSetOperations.TypedTuple<V>>	distinctRandomMembersWithScore(@NonNull K key, long count)	Get count distinct random elements with their score from set at key.
Mono<Double>	incrementScore(@NonNull K key, @NonNull V value, double delta)	Increment the score of element with value in sorted set by increment.
default Flux<V>	intersect(@NonNull K key, @NonNull K otherKey)	Intersect sorted sets.
Flux<V>	intersect(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys)	Intersect sorted sets.
default Mono<Long>	intersectAndStore(@NonNull K key, @NonNull K otherKey, @NonNull K destKey)	Intersect sorted sets at key and otherKey and store result in destination destKey.
Mono<Long>	intersectAndStore(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys, @NonNull K destKey)	Intersect sorted sets at key and otherKeys and store result in destination destKey.
default Mono<Long>	intersectAndStore(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys, @NonNull K destKey, @NonNull Aggregate aggregate)	Intersect sorted sets at key and otherKeys and store result in destination destKey.
Mono<Long>	intersectAndStore(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys, @NonNull K destKey, @NonNull Aggregate aggregate, @NonNull Weights weights)	Intersect sorted sets at key and otherKeys and store result in destination destKey.
default Flux<ZSetOperations.TypedTuple<V>>	intersectWithScores(@NonNull K key, @NonNull K otherKey)	Intersect sorted sets.
Flux<ZSetOperations.TypedTuple<V>>	intersectWithScores(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys)	Intersect sorted sets.
Flux<ZSetOperations.TypedTuple<V>>	intersectWithScores(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys, @NonNull Aggregate aggregate, @NonNull Weights weights)	Intersect sorted sets.
default Flux<ZSetOperations.TypedTuple<V>>	intersectWithScores(@NonNull K key, @NonNull Collection<K> otherKeys, @NonNull Aggregate aggregate)	Intersect sorted sets at key and otherKeys .
Mono<Long>	lexCount(@NonNull K key, @NonNull Range<String> range)	Count number of elements within sorted set with a value between Range.getLowerBound() and Range.getUpperBound() applying lexicographical ordering.
Mono<ZSetOperations.TypedTuple<V>>	popMax(@NonNull K key)	Remove and return the value with its score having the highest score from sorted set at key.
Flux<ZSetOperations.TypedTuple<V>>	popMax(@NonNull K key, long count)	Remove and return count values with their score having the highest score from sorted set at key.
Mono<ZSetOperations.TypedTuple<V>>	popMax(@NonNull K key, @NonNull Duration timeout)	Remove and return the value with its score having the highest score from sorted set at key.
Mono<ZSetOperations.TypedTuple<V>>	popMin(@NonNull K key)	Remove and return the value with its score having the lowest score from sorted set at key.
Flux<ZSetOperations.TypedTuple<V>>	popMin(@NonNull K key, long count)	Remove and return count values with their score having the lowest score from sorted set at key.
Mono<ZSetOperations.TypedTuple<V>>	popMin(@NonNull K key, Duration timeout)	Remove and return the value with its score having the lowest score from sorted set at key.
Mono<V>	randomMember(@NonNull K key)	Get random element from set at key.
Flux<V>	randomMembers(@NonNull K key, long count)	Get count random elements from set at key.
Flux<ZSetOperations.TypedTuple<V>>	randomMembersWithScore(@NonNull K key, long count)	Get count random elements with their score from set at key.
Mono<ZSetOperations.TypedTuple<V>>	randomMemberWithScore(@NonNull K key)	Get random element with its score from set at key.
Flux<V>	range(@NonNull K key, @NonNull Range<Long> range)	Get elements between start and end from sorted set.
default Mono<Long>	rangeAndStoreByLex(@NonNull K srcKey, @NonNull K dstKey, @NonNull Range<String> range)	Store all elements at dstKey with lexicographical ordering from ZSET at srcKey with a value between Range.getLowerBound() and Range.getUpperBound().
Mono<Long>	rangeAndStoreByLex(@NonNull K srcKey, @NonNull K dstKey, @NonNull Range<String> range, @NonNull Limit limit)	Store n elements at dstKey, where n = Limit.getCount(), starting at Limit.getOffset() with lexicographical ordering from ZSET at srcKey with a value between Range.getLowerBound() and Range.getUpperBound().
default @Nullable Mono<Long>	rangeAndStoreByScore(@NonNull K srcKey, @NonNull K dstKey, @NonNull Range<Double> range)	Store all elements at dstKey with ordering by score from ZSET at srcKey with a score between Range.getLowerBound() and Range.getUpperBound().
Mono<Long>	rangeAndStoreByScore(@NonNull K srcKey, @NonNull K dstKey, @NonNull Range<Double> range, @NonNull Limit limit)	Store n elements at dstKey, where n = Limit.getCount(), starting at Limit.getOffset() with ordering by score from ZSET at srcKey with a score between Range.getLowerBound() and Range.getUpperBound().
Flux<V>	rangeByLex(@NonNull K key, @NonNull Range<String> range)	Get all elements with lexicographical ordering from ZSET at key with a value between Range.getLowerBound() and Range.getUpperBound().
Flux<V>	rangeByLex(@NonNull K key, @NonNull Range<String> range, @NonNull Limit limit)	Get all elements n elements, where n = Limit.getCount(), starting at Limit.getOffset() with lexicographical ordering from ZSET at key with a value between Range.getLowerBound() and Range.getUpperBound().
Flux<V>	rangeByScore(@NonNull K key, @NonNull Range<Double> range)	Get elements where score is between min and max from sorted set.
Flux<V>	rangeByScore(@NonNull K key, @NonNull Range<Double> range, @NonNull Limit limit)	Get elements in range from start to end where score is between min and max from sorted set.
Flux<ZSetOperations.TypedTuple<V>>	rangeByScoreWithScores(@NonNull K key, @NonNull Range<Double> range)	Get set of Tuples where score is between min and max from sorted set.
Flux<ZSetOperations.TypedTuple<V>>	rangeByScoreWithScores(@NonNull K key, @NonNull Range<Double> range, @NonNull Limit limit)	Get set of Tuples in range from start to end where score is between min and max from sorted set.
Flux<ZSetOperations.TypedTuple<V>>	rangeWithScores(@NonNull K key, @NonNull Range<Long> range)	Get set of Tuples between start and end from sorted set.
Mono<Long>	rank(@NonNull K key, @NonNull Object o)	Determine the index of element with value in a sorted set.
Mono<Long>	remove(@NonNull K key, @NonNull Object @NonNull ... values)	Remove values from sorted set.
Mono<Long>	removeRange(@NonNull K key, @NonNull Range<Long> range)	Remove elements in range between start and end from sorted set with key.
Mono<Long>	removeRangeByLex(@NonNull K key, @NonNull Range<String> range)	Remove elements in range from sorted set with key.
Mono<Long>	removeRangeByScore(@NonNull K key, @NonNull Range<Double> range)	Remove elements with scores between min and max from sorted set with key.
Flux<V>	reverseRange(@NonNull K key, @NonNull Range<Long> range)	Get elements in range from start to end from sorted set ordered from high to low.
default Mono<Long>	reverseRangeAndStoreByLex(@NonNull K srcKey, @NonNull K dstKey, @NonNull Range<String> range)	Store all elements at dstKey with reverse lexicographical ordering from ZSET at srcKey with a value between Range.getLowerBound() and Range.getUpperBound().
Mono<Long>	reverseRangeAndStoreByLex(@NonNull K srcKey, @NonNull K dstKey, @NonNull Range<String> range, @NonNull Limit limit)	Store n elements at dstKey, where n = Limit.getCount(), starting at Limit.getOffset() with reverse lexicographical ordering from ZSET at srcKey with a value between Range.getLowerBound() and Range.getUpperBound().
default Mono<Long>	reverseRangeAndStoreByScore(@NonNull K srcKey, @NonNull K dstKey, @NonNull Range<Double> range)	Store all elements at dstKey with reverse ordering by score from ZSET at srcKey with a score between Range.getLowerBound() and Range.getUpperBound().
Mono<Long>	reverseRangeAndStoreByScore(@NonNull K srcKey, @NonNull K dstKey, @NonNull Range<Double> range, @NonNull Limit limit)	Store n elements at dstKey, where n = Limit.getCount(), starting at Limit.getOffset() with reverse ordering by score from ZSET at srcKey with a score between Range.getLowerBound() and Range.getUpperBound().
Flux<V>	reverseRangeByLex(@NonNull K key, @NonNull Range<String> range)	Get all elements with reverse lexicographical ordering from ZSET at key with a value between Range.getLowerBound() and Range.getUpperBound().
Flux<V>	reverseRangeByLex(@NonNull K key, @NonNull Range<String> range, @NonNull Limit limit)	Get all elements n elements, where n = Limit.getCount(), starting at Limit.getOffset() with reverse lexicographical ordering from ZSET at key with a value between Range.getLowerBound() and Range.getUpperBound().
Flux<V>	reverseRangeByScore(@NonNull K key, @NonNull Range<Double> range)	Get elements where score is between min and max from sorted set ordered from high to low.
Flux<V>	reverseRangeByScore(@NonNull K key, @NonNull Range<Double> range, @NonNull Limit limit)	Get elements in range from start to end where score is between min and max from sorted set ordered high -> low.
Flux<ZSetOperations.TypedTuple<V>>	reverseRangeByScoreWithScores(@NonNull K key, @NonNull Range<Double> range)	Get set of Tuple where score is between min and max from sorted set ordered from high to low.
Flux<ZSetOperations.TypedTuple<V>>	reverseRangeByScoreWithScores(@NonNull K key, @NonNull Range<Double> range, @NonNull Limit limit)	Get set of Tuple in range from start to end where score is between min and max from sorted set ordered high -> low.
Flux<ZSetOperations.TypedTuple<V>>	reverseRangeWithScores(@NonNull K key, @NonNull Range<Long> range)	Get set of Tuples in range from start to end from sorted set ordered from high to low.
Mono<Long>	reverseRank(@NonNull K key, @NonNull Object o)	Determine the index of element with value in a sorted set when scored high to low.
default Flux<ZSetOperations.TypedTuple<V>>	scan(@NonNull K key)	Use a Flux to iterate over entries in the sorted set at key.
Flux<ZSetOperations.TypedTuple<V>>	scan(@NonNull K key, @Nullable ScanOptions options)	Use a Flux to iterate over entries in the sorted set at key given ScanOptions.
Mono<Double>	score(@NonNull K key, @NonNull Object o)	Get the score of element with value from sorted set with key key.
Mono<List<Double>>	score(@NonNull K key, @NonNull Object @NonNull ... o)	Get the scores of elements with values from sorted set with key key.
Mono<Long>	size(@NonNull K key)	Returns the number of elements of the sorted set stored with given key.
default Flux<V>	union(@NonNull K key, @NonNull K otherKey)	Union sorted sets.
Flux<V>	union(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys)	Union sorted sets.
Mono<Long>	unionAndStore(@NonNull K key, @NonNull K otherKey, @NonNull K destKey)	Union sorted sets at key and otherKeys and store result in destination destKey.
Mono<Long>	unionAndStore(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys, @NonNull K destKey)	Union sorted sets at key and otherKeys and store result in destination destKey.
default Mono<Long>	unionAndStore(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys, @NonNull K destKey, @NonNull Aggregate aggregate)	Union sorted sets at key and otherKeys and store result in destination destKey.
Mono<Long>	unionAndStore(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys, @NonNull K destKey, @NonNull Aggregate aggregate, @NonNull Weights weights)	Union sorted sets at key and otherKeys and store result in destination destKey.
default Flux<ZSetOperations.TypedTuple<V>>	unionWithScores(@NonNull K key, @NonNull K otherKey)	Union sorted sets.
Flux<ZSetOperations.TypedTuple<V>>	unionWithScores(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys)	Union sorted sets.
default Flux<ZSetOperations.TypedTuple<V>>	unionWithScores(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys, @NonNull Aggregate aggregate)	Union sorted sets at key and otherKeys .
Flux<ZSetOperations.TypedTuple<V>>	unionWithScores(@NonNull K key, @NonNull Collection<@NonNull K> otherKeys, @NonNull Aggregate aggregate, @NonNull Weights weights)	Union sorted sets.

Method Details

add

Mono<Boolean> add(@NonNull K key,
 @NonNull V value,
 double score)

Add value to a sorted set at key, or update its score if it already exists.

Parameters:

key - must not be null.

value - the value.

score - the score.

Returns:

See Also:

• Redis Documentation: ZADD

addAll

Mono<Long> addAll(@NonNull K key,
 @NonNull Collection<? extends @NonNull ZSetOperations.TypedTuple<V>> tuples)

Add tuples to a sorted set at key, or update their score if it already exists.

Parameters:

key - must not be null.

tuples - the score.

Returns:

See Also:

• Redis Documentation: ZADD

remove

Mono<Long> remove(@NonNull K key,
 @NonNull Object @NonNull ... values)

Remove values from sorted set. Return number of removed elements.

Parameters:

key - must not be null.

values - must not be null.

Returns:

See Also:

• Redis Documentation: ZREM

incrementScore

Mono<Double> incrementScore(@NonNull K key,
 @NonNull V value,
 double delta)

Increment the score of element with value in sorted set by increment.

Parameters:

key - must not be null.

value - the value.

delta - the delta to add. Can be negative.

Returns:

See Also:

• Redis Documentation: ZINCRBY

randomMember

Mono<V> randomMember(@NonNull K key)

Get random element from set at key.

Parameters:

key - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZRANDMEMBER

distinctRandomMembers

Flux<V> distinctRandomMembers(@NonNull K key,
 long count)

Get count distinct random elements from set at key.

Parameters:

key - must not be null.

count - number of members to return.

Returns:

Throws:

IllegalArgumentException - if count is negative.

Since:

2.6

See Also:

• Redis Documentation: ZRANDMEMBER

randomMembers

Flux<V> randomMembers(@NonNull K key,
 long count)

Get count random elements from set at key.

Parameters:

key - must not be null.

count - number of members to return.

Returns:

Throws:

IllegalArgumentException - if count is negative.

Since:

2.6

See Also:

• Redis Documentation: ZRANDMEMBER

randomMemberWithScore

Mono<ZSetOperations.TypedTuple<V>> randomMemberWithScore(@NonNull K key)

Get random element with its score from set at key.

Parameters:

key - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZRANDMEMBER

distinctRandomMembersWithScore

Flux<ZSetOperations.TypedTuple<V>> distinctRandomMembersWithScore(@NonNull K key,
 long count)

Get count distinct random elements with their score from set at key.

Parameters:

key - must not be null.

count - number of members to return.

Returns:

Throws:

IllegalArgumentException - if count is negative.

Since:

2.6

See Also:

• Redis Documentation: ZRANDMEMBER

randomMembersWithScore

Flux<ZSetOperations.TypedTuple<V>> randomMembersWithScore(@NonNull K key,
 long count)

Get count random elements with their score from set at key.

Parameters:

key - must not be null.

count - number of members to return.

Returns:

Throws:

IllegalArgumentException - if count is negative.

Since:

2.6

See Also:

• Redis Documentation: ZRANDMEMBER

rank

Mono<Long> rank(@NonNull K key,
 @NonNull Object o)

Determine the index of element with value in a sorted set.

Parameters:

key - must not be null.

o - the value.

Returns:

See Also:

• Redis Documentation: ZRANK

reverseRank

Mono<Long> reverseRank(@NonNull K key,
 @NonNull Object o)

Determine the index of element with value in a sorted set when scored high to low.

Parameters:

key - must not be null.

o - the value.

Returns:

See Also:

• Redis Documentation: ZREVRANK

range

Flux<V> range(@NonNull K key,
 @NonNull Range<Long> range)

Get elements between start and end from sorted set.

Parameters:

key - must not be null.

range - must not be null.

Returns:

See Also:

• Redis Documentation: ZRANGE

rangeWithScores

Flux<ZSetOperations.TypedTuple<V>> rangeWithScores(@NonNull K key,
 @NonNull Range<Long> range)

Get set of Tuples between start and end from sorted set.

Parameters:

key - must not be null.

range - must not be null.

Returns:

See Also:

• Redis Documentation: ZRANGE

rangeByScore

Flux<V> rangeByScore(@NonNull K key,
 @NonNull Range<Double> range)

Get elements where score is between min and max from sorted set.

Parameters:

key - must not be null.

range - must not be null.

Returns:

See Also:

• Redis Documentation: ZRANGEBYSCORE

rangeByScoreWithScores

Flux<ZSetOperations.TypedTuple<V>> rangeByScoreWithScores(@NonNull K key,
 @NonNull Range<Double> range)

Get set of Tuples where score is between min and max from sorted set.

Parameters:

key - must not be null.

range - must not be null.

Returns:

See Also:

• Redis Documentation: ZRANGEBYSCORE

rangeByScore

Flux<V> rangeByScore(@NonNull K key,
 @NonNull Range<Double> range,
 @NonNull Limit limit)

Get elements in range from start to end where score is between min and max from sorted set.

Parameters:

key - must not be null.

range -

limit -

Returns:

See Also:

• Redis Documentation: ZRANGEBYSCORE

rangeByScoreWithScores

Flux<ZSetOperations.TypedTuple<V>> rangeByScoreWithScores(@NonNull K key,
 @NonNull Range<Double> range,
 @NonNull Limit limit)

Get set of Tuples in range from start to end where score is between min and max from sorted set.

Parameters:

key -

range -

limit -

Returns:

See Also:

• Redis Documentation: ZRANGEBYSCORE

reverseRange

Flux<V> reverseRange(@NonNull K key,
 @NonNull Range<Long> range)

Get elements in range from start to end from sorted set ordered from high to low.

Parameters:

key - must not be null.

range -

Returns:

See Also:

• Redis Documentation: ZREVRANGE

reverseRangeWithScores

Flux<ZSetOperations.TypedTuple<V>> reverseRangeWithScores(@NonNull K key,
 @NonNull Range<Long> range)

Get set of Tuples in range from start to end from sorted set ordered from high to low.

Parameters:

key - must not be null.

range -

Returns:

See Also:

• Redis Documentation: ZREVRANGE

reverseRangeByScore

Flux<V> reverseRangeByScore(@NonNull K key,
 @NonNull Range<Double> range)

Get elements where score is between min and max from sorted set ordered from high to low.

Parameters:

key - must not be null.

range -

Returns:

See Also:

• Redis Documentation: ZREVRANGEBYSCORE

reverseRangeByScoreWithScores

Flux<ZSetOperations.TypedTuple<V>> reverseRangeByScoreWithScores(@NonNull K key,
 @NonNull Range<Double> range)

Get set of Tuple where score is between min and max from sorted set ordered from high to low.

Parameters:

key - must not be null.

range -

Returns:

See Also:

• Redis Documentation: ZREVRANGEBYSCORE

reverseRangeByScore

Flux<V> reverseRangeByScore(@NonNull K key,
 @NonNull Range<Double> range,
 @NonNull Limit limit)

Get elements in range from start to end where score is between min and max from sorted set ordered high -> low.

Parameters:

key - must not be null.

range -

limit -

Returns:

See Also:

• Redis Documentation: ZREVRANGEBYSCORE

reverseRangeByScoreWithScores

Flux<ZSetOperations.TypedTuple<V>> reverseRangeByScoreWithScores(@NonNull K key,
 @NonNull Range<Double> range,
 @NonNull Limit limit)

Get set of Tuple in range from start to end where score is between min and max from sorted set ordered high -> low.

Parameters:

key - must not be null.

range -

limit -

Returns:

See Also:

• Redis Documentation: ZREVRANGEBYSCORE

rangeAndStoreByLex

default Mono<Long> rangeAndStoreByLex(@NonNull K srcKey,
 @NonNull K dstKey,
 @NonNull Range<String> range)

Store all elements at dstKey with lexicographical ordering from ZSET at srcKey with a value between Range.getLowerBound() and Range.getUpperBound().

Parameters:

srcKey - must not be null.

dstKey - must not be null.

range - must not be null.

Returns:

the number of stored elements.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

rangeAndStoreByLex

Mono<Long> rangeAndStoreByLex(@NonNull K srcKey,
 @NonNull K dstKey,
 @NonNull Range<String> range,
 @NonNull Limit limit)

Store n elements at dstKey, where n = Limit.getCount(), starting at Limit.getOffset() with lexicographical ordering from ZSET at srcKey with a value between Range.getLowerBound() and Range.getUpperBound().

Parameters:

srcKey - must not be null.

dstKey - must not be null.

range - must not be null.

limit - must not be null.

Returns:

the number of stored elements.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

reverseRangeAndStoreByLex

default Mono<Long> reverseRangeAndStoreByLex(@NonNull K srcKey,
 @NonNull K dstKey,
 @NonNull Range<String> range)

Store all elements at dstKey with reverse lexicographical ordering from ZSET at srcKey with a value between Range.getLowerBound() and Range.getUpperBound().

Parameters:

srcKey - must not be null.

dstKey - must not be null.

range - must not be null.

Returns:

the number of stored elements.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

reverseRangeAndStoreByLex

Mono<Long> reverseRangeAndStoreByLex(@NonNull K srcKey,
 @NonNull K dstKey,
 @NonNull Range<String> range,
 @NonNull Limit limit)

Store n elements at dstKey, where n = Limit.getCount(), starting at Limit.getOffset() with reverse lexicographical ordering from ZSET at srcKey with a value between Range.getLowerBound() and Range.getUpperBound().

Parameters:

srcKey - must not be null.

dstKey - must not be null.

range - must not be null.

limit - must not be null.

Returns:

the number of stored elements.

Since:

3.0

See Also:

• reverseRangeByLex(Object, Range, Limit)
• Redis Documentation: ZRANGESTORE

rangeAndStoreByScore

default @Nullable Mono<Long> rangeAndStoreByScore(@NonNull K srcKey,
 @NonNull K dstKey,
 @NonNull Range<Double> range)

Store all elements at dstKey with ordering by score from ZSET at srcKey with a score between Range.getLowerBound() and Range.getUpperBound().

Parameters:

srcKey - must not be null.

dstKey - must not be null.

range - must not be null.

Returns:

the number of stored elements.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

rangeAndStoreByScore

Mono<Long> rangeAndStoreByScore(@NonNull K srcKey,
 @NonNull K dstKey,
 @NonNull Range<Double> range,
 @NonNull Limit limit)

Store n elements at dstKey, where n = Limit.getCount(), starting at Limit.getOffset() with ordering by score from ZSET at srcKey with a score between Range.getLowerBound() and Range.getUpperBound().

Parameters:

srcKey - must not be null.

dstKey - must not be null.

range - must not be null.

limit - must not be null.

Returns:

the number of stored elements.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

reverseRangeAndStoreByScore

default Mono<Long> reverseRangeAndStoreByScore(@NonNull K srcKey,
 @NonNull K dstKey,
 @NonNull Range<Double> range)

Store all elements at dstKey with reverse ordering by score from ZSET at srcKey with a score between Range.getLowerBound() and Range.getUpperBound().

Parameters:

srcKey - must not be null.

dstKey - must not be null.

range - must not be null.

Returns:

the number of stored elements.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

reverseRangeAndStoreByScore

Mono<Long> reverseRangeAndStoreByScore(@NonNull K srcKey,
 @NonNull K dstKey,
 @NonNull Range<Double> range,
 @NonNull Limit limit)

Store n elements at dstKey, where n = Limit.getCount(), starting at Limit.getOffset() with reverse ordering by score from ZSET at srcKey with a score between Range.getLowerBound() and Range.getUpperBound().

Parameters:

srcKey - must not be null.

dstKey - must not be null.

range - must not be null.

limit - must not be null.

Returns:

the number of stored elements.

Since:

3.0

See Also:

• Redis Documentation: ZRANGESTORE

scan

default Flux<ZSetOperations.TypedTuple<V>> scan(@NonNull K key)

Use a Flux to iterate over entries in the sorted set at key. The resulting Flux acts as a cursor and issues ZSCAN commands itself as long as the subscriber signals demand.

Parameters:

key - must not be null.

Returns:

the Flux emitting the values one by one or an empty Flux if none exist.

Throws:

IllegalArgumentException - when given key is null.

Since:

2.1

See Also:

• Redis Documentation: ZSCAN

scan

Flux<ZSetOperations.TypedTuple<V>> scan(@NonNull K key,
 @Nullable ScanOptions options)

Use a Flux to iterate over entries in the sorted set at key given ScanOptions. The resulting Flux acts as a cursor and issues ZSCAN commands itself as long as the subscriber signals demand.

Parameters:

key - must not be null.

options - must not be null. Use ScanOptions.NONE instead.

Returns:

the Flux emitting the values one by one or an empty Flux if none exist.

Throws:

IllegalArgumentException - when one of the required arguments is null.

Since:

2.1

See Also:

• Redis Documentation: ZSCAN

count

Mono<Long> count(@NonNull K key,
 @NonNull Range<Double> range)

Count number of elements within sorted set with scores between min and max.

Parameters:

key - must not be null.

range -

Returns:

See Also:

• Redis Documentation: ZCOUNT

lexCount

Mono<Long> lexCount(@NonNull K key,
 @NonNull Range<String> range)

Count number of elements within sorted set with a value between Range.getLowerBound() and Range.getUpperBound() applying lexicographical ordering.

Parameters:

key - must not be null.

range - must not be null

Returns:

Since:

2.4

See Also:

• Redis Documentation: ZLEXCOUNT

popMin

Mono<ZSetOperations.TypedTuple<V>> popMin(@NonNull K key)

Remove and return the value with its score having the lowest score from sorted set at key.

Parameters:

key - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZPOPMIN

popMin

Flux<ZSetOperations.TypedTuple<V>> popMin(@NonNull K key,
 long count)

Remove and return count values with their score having the lowest score from sorted set at key.

Parameters:

key - must not be null.

count - number of elements to pop.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZPOPMIN

popMin

Mono<ZSetOperations.TypedTuple<V>> popMin(@NonNull K key,
 Duration timeout)

Remove and return the value with its score having the lowest score from sorted set at key.

Parameters:

key - must not be null.

timeout - maximal duration to wait until an entry in the list at key is available. Must be either Duration.ZERO or greater 1 second, must not be null. A timeout of zero can be used to wait indefinitely. Durations between zero and one second are not supported.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZPOPMIN

popMax

Mono<ZSetOperations.TypedTuple<V>> popMax(@NonNull K key)

Remove and return the value with its score having the highest score from sorted set at key.

Parameters:

key - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZPOPMAX

popMax

Flux<ZSetOperations.TypedTuple<V>> popMax(@NonNull K key,
 long count)

Remove and return count values with their score having the highest score from sorted set at key.

Parameters:

key - must not be null.

count - number of elements to pop.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZPOPMAX

popMax

Mono<ZSetOperations.TypedTuple<V>> popMax(@NonNull K key,
 @NonNull Duration timeout)

Remove and return the value with its score having the highest score from sorted set at key.

Parameters:

key - must not be null.

timeout - maximal duration to wait until an entry in the list at key is available. Must be either Duration.ZERO or greater 1 second, must not be null. A timeout of zero can be used to wait indefinitely. Durations between zero and one second are not supported.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZPOPMIN

size

Mono<Long> size(@NonNull K key)

Returns the number of elements of the sorted set stored with given key.

Parameters:

key -

Returns:

See Also:

• Redis Documentation: ZCARD

score

Mono<Double> score(@NonNull K key,
 @NonNull Object o)

Get the score of element with value from sorted set with key key.

Parameters:

key - must not be null.

o - the value.

Returns:

See Also:

• Redis Documentation: ZSCORE

score

Mono<List<Double>> score(@NonNull K key,
 @NonNull Object @NonNull ... o)

Get the scores of elements with values from sorted set with key key.

Parameters:

key - must not be null.

o - the values.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZMSCORE

removeRange

Mono<Long> removeRange(@NonNull K key,
 @NonNull Range<Long> range)

Remove elements in range between start and end from sorted set with key.

Parameters:

key - must not be null.

range -

Returns:

See Also:

• Redis Documentation: ZREMRANGEBYRANK

removeRangeByLex

Mono<Long> removeRangeByLex(@NonNull K key,
 @NonNull Range<String> range)

Remove elements in range from sorted set with key.

Parameters:

key - must not be null.

range - must not be null.

Returns:

a Mono emitting the number or removed elements.

Since:

2.5

See Also:

• Redis Documentation: ZREMRANGEBYRANK

removeRangeByScore

Mono<Long> removeRangeByScore(@NonNull K key,
 @NonNull Range<Double> range)

Remove elements with scores between min and max from sorted set with key.

Parameters:

key - must not be null.

range -

Returns:

See Also:

• Redis Documentation: ZREMRANGEBYSCORE

difference

default Flux<V> difference(@NonNull K key,
 @NonNull K otherKey)

Diff sorted sets.

Parameters:

key - must not be null.

otherKey - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZDIFF

difference

Flux<V> difference(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys)

Diff sorted sets.

Parameters:

key - must not be null.

otherKeys - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZDIFF

differenceWithScores

default Flux<ZSetOperations.TypedTuple<V>> differenceWithScores(@NonNull K key,
 @NonNull K otherKey)

Diff sorted sets.

Parameters:

key - must not be null.

otherKey - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZDIFF

differenceWithScores

Flux<ZSetOperations.TypedTuple<V>> differenceWithScores(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys)

Diff sorted sets.

Parameters:

key - must not be null.

otherKeys - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZDIFF

differenceAndStore

default Mono<Long> differenceAndStore(@NonNull K key,
 @NonNull K otherKey,
 @NonNull K destKey)

Diff sorted sets and store result in destination destKey.

Parameters:

key - must not be null.

otherKey - must not be null.

destKey - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZDIFFSTORE

differenceAndStore

Mono<Long> differenceAndStore(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys,
 @NonNull K destKey)

Diff sorted sets and store result in destination destKey.

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZDIFFSTORE

intersect

default Flux<V> intersect(@NonNull K key,
 @NonNull K otherKey)

Intersect sorted sets.

Parameters:

key - must not be null.

otherKey - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZINTER

intersect

Flux<V> intersect(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys)

Intersect sorted sets.

Parameters:

key - must not be null.

otherKeys - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZINTER

intersectWithScores

default Flux<ZSetOperations.TypedTuple<V>> intersectWithScores(@NonNull K key,
 @NonNull K otherKey)

Intersect sorted sets.

Parameters:

key - must not be null.

otherKey - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZINTER

intersectWithScores

Flux<ZSetOperations.TypedTuple<V>> intersectWithScores(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys)

Intersect sorted sets.

Parameters:

key - must not be null.

otherKeys - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZINTER

intersectWithScores

default Flux<ZSetOperations.TypedTuple<V>> intersectWithScores(@NonNull K key,
 @NonNull Collection<K> otherKeys,
 @NonNull Aggregate aggregate)

Intersect sorted sets at key and otherKeys .

Parameters:

key - must not be null.

otherKeys - must not be null.

aggregate - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZINTER

intersectWithScores

Flux<ZSetOperations.TypedTuple<V>> intersectWithScores(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys,
 @NonNull Aggregate aggregate,
 @NonNull Weights weights)

Intersect sorted sets.

Parameters:

key - must not be null.

otherKeys - must not be null.

aggregate - must not be null.

weights - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZINTER

intersectAndStore

default Mono<Long> intersectAndStore(@NonNull K key,
 @NonNull K otherKey,
 @NonNull K destKey)

Intersect sorted sets at key and otherKey and store result in destination destKey.

Parameters:

key - must not be null.

otherKey - must not be null.

destKey - must not be null.

Returns:

See Also:

• Redis Documentation: ZINTERSTORE

intersectAndStore

Mono<Long> intersectAndStore(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys,
 @NonNull K destKey)

Intersect sorted sets at key and otherKeys and store result in destination destKey.

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

Returns:

See Also:

• Redis Documentation: ZINTERSTORE

intersectAndStore

default Mono<Long> intersectAndStore(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys,
 @NonNull K destKey,
 @NonNull Aggregate aggregate)

Intersect sorted sets at key and otherKeys and store result in destination destKey.

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

aggregate - must not be null.

Returns:

Since:

2.1

See Also:

• Redis Documentation: ZINTERSTORE

intersectAndStore

Mono<Long> intersectAndStore(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys,
 @NonNull K destKey,
 @NonNull Aggregate aggregate,
 @NonNull Weights weights)

Intersect sorted sets at key and otherKeys and store result in destination destKey.

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

aggregate - must not be null.

weights - must not be null.

Returns:

Since:

2.1

See Also:

• Redis Documentation: ZINTERSTORE

union

default Flux<V> union(@NonNull K key,
 @NonNull K otherKey)

Union sorted sets.

Parameters:

key - must not be null.

otherKey - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZUNION

union

Flux<V> union(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys)

Union sorted sets.

Parameters:

key - must not be null.

otherKeys - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZUNION

unionWithScores

default Flux<ZSetOperations.TypedTuple<V>> unionWithScores(@NonNull K key,
 @NonNull K otherKey)

Union sorted sets.

Parameters:

key - must not be null.

otherKey - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZUNION

unionWithScores

Flux<ZSetOperations.TypedTuple<V>> unionWithScores(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys)

Union sorted sets.

Parameters:

key - must not be null.

otherKeys - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZUNION

unionWithScores

default Flux<ZSetOperations.TypedTuple<V>> unionWithScores(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys,
 @NonNull Aggregate aggregate)

Union sorted sets at key and otherKeys .

Parameters:

key - must not be null.

otherKeys - must not be null.

aggregate - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZUNION

unionWithScores

Flux<ZSetOperations.TypedTuple<V>> unionWithScores(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys,
 @NonNull Aggregate aggregate,
 @NonNull Weights weights)

Union sorted sets.

Parameters:

key - must not be null.

otherKeys - must not be null.

aggregate - must not be null.

weights - must not be null.

Returns:

Since:

2.6

See Also:

• Redis Documentation: ZUNION

unionAndStore

Mono<Long> unionAndStore(@NonNull K key,
 @NonNull K otherKey,
 @NonNull K destKey)

Union sorted sets at key and otherKeys and store result in destination destKey.

Parameters:

key - must not be null.

otherKey - must not be null.

destKey - must not be null.

Returns:

See Also:

• Redis Documentation: ZUNIONSTORE

unionAndStore

Mono<Long> unionAndStore(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys,
 @NonNull K destKey)

Union sorted sets at key and otherKeys and store result in destination destKey.

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

Returns:

See Also:

• Redis Documentation: ZUNIONSTORE

unionAndStore

default Mono<Long> unionAndStore(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys,
 @NonNull K destKey,
 @NonNull Aggregate aggregate)

Union sorted sets at key and otherKeys and store result in destination destKey.

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

aggregate - must not be null.

Returns:

Since:

2.1

See Also:

• Redis Documentation: ZUNIONSTORE

unionAndStore

Mono<Long> unionAndStore(@NonNull K key,
 @NonNull Collection<@NonNull K> otherKeys,
 @NonNull K destKey,
 @NonNull Aggregate aggregate,
 @NonNull Weights weights)

Union sorted sets at key and otherKeys and store result in destination destKey.

Parameters:

key - must not be null.

otherKeys - must not be null.

destKey - must not be null.

aggregate - must not be null.

weights - must not be null.

Returns:

Since:

2.1

See Also:

• Redis Documentation: ZUNIONSTORE

rangeByLex

Flux<V> rangeByLex(@NonNull K key,
 @NonNull Range<String> range)

Get all elements with lexicographical ordering from ZSET at key with a value between Range.getLowerBound() and Range.getUpperBound().

Parameters:

key - must not be null.

range - must not be null.

See Also:

• Redis Documentation: ZRANGEBYLEX

rangeByLex

Flux<V> rangeByLex(@NonNull K key,
 @NonNull Range<String> range,
 @NonNull Limit limit)

Get all elements n elements, where n = Limit.getCount(), starting at Limit.getOffset() with lexicographical ordering from ZSET at key with a value between Range.getLowerBound() and Range.getUpperBound().

Parameters:

key - must not be null

range - must not be null.

limit - can be null.

Returns:

See Also:

• Redis Documentation: ZRANGEBYLEX

reverseRangeByLex

Flux<V> reverseRangeByLex(@NonNull K key,
 @NonNull Range<String> range)

Get all elements with reverse lexicographical ordering from ZSET at key with a value between Range.getLowerBound() and Range.getUpperBound().

Parameters:

key - must not be null.

range - must not be null.

See Also:

• Redis Documentation: ZREVRANGEBYLEX

reverseRangeByLex

Flux<V> reverseRangeByLex(@NonNull K key,
 @NonNull Range<String> range,
 @NonNull Limit limit)

Get all elements n elements, where n = Limit.getCount(), starting at Limit.getOffset() with reverse lexicographical ordering from ZSET at key with a value between Range.getLowerBound() and Range.getUpperBound().

Parameters:

key - must not be null

range - must not be null.

limit - can be null.

Returns:

See Also:

• Redis Documentation: ZREVRANGEBYLEX

delete

Mono<Boolean> delete(@NonNull K key)

Removes the given key.

Parameters:

key - must not be null.