org.springframework.data.redis.core

Interface ZSetOperations<K,V>

public interface ZSetOperations<K,V>

Redis ZSet/sorted set specific operations.

Author:

Costin Leau, Christoph Strobl, Mark Paluch, Rosty Kerei, Wongoo (望哥)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ZSetOperations.TypedTuple<V> Typed ZSet tuple.

Method Summary

Modifier and Type	Method and Description
Long	add(K key, Set<ZSetOperations.TypedTuple<V>> tuples) Add tuples to a sorted set at key, or update its score if it already exists.
Boolean	add(K key, V value, double score) Add value to a sorted set at key, or update its score if it already exists.
Long	count(K key, double min, double max) Count number of elements within sorted set with scores between min and max.
RedisOperations<K,V>	getOperations()
Double	incrementScore(K key, V value, double delta) Increment the score of element with value in sorted set by increment.
Long	intersectAndStore(K key, Collection<K> otherKeys, K destKey) Intersect sorted sets at key and otherKeys and store result in destination destKey.
default Long	intersectAndStore(K key, Collection<K> otherKeys, K destKey, RedisZSetCommands.Aggregate aggregate) Intersect sorted sets at key and otherKeys and store result in destination destKey.
Long	intersectAndStore(K key, Collection<K> otherKeys, K destKey, RedisZSetCommands.Aggregate aggregate, RedisZSetCommands.Weights weights) Intersect sorted sets at key and otherKeys and store result in destination destKey.
Long	intersectAndStore(K key, K otherKey, K destKey) Intersect sorted sets at key and otherKey and store result in destination destKey.
Set<V>	range(K key, long start, long end) Get elements between start and end from sorted set.
Set<V>	rangeByLex(K key, RedisZSetCommands.Range range) Get all elements with lexicographical ordering from ZSET at key with a value between RedisZSetCommands.Range.getMin() and RedisZSetCommands.Range.getMax().
Set<V>	rangeByLex(K key, RedisZSetCommands.Range range, RedisZSetCommands.Limit limit) Get all elements n elements, where n = RedisZSetCommands.Limit.getCount(), starting at RedisZSetCommands.Limit.getOffset() with lexicographical ordering from ZSET at key with a value between RedisZSetCommands.Range.getMin() and RedisZSetCommands.Range.getMax().
Set<V>	rangeByScore(K key, double min, double max) Get elements where score is between min and max from sorted set.
Set<V>	rangeByScore(K key, double min, double max, long offset, long count) Get elements in range from start to end where score is between min and max from sorted set.
Set<ZSetOperations.TypedTuple<V>>	rangeByScoreWithScores(K key, double min, double max) Get set of RedisZSetCommands.Tuples where score is between min and max from sorted set.
Set<ZSetOperations.TypedTuple<V>>	rangeByScoreWithScores(K key, double min, double max, long offset, long count) Get set of RedisZSetCommands.Tuples in range from start to end where score is between min and max from sorted set.
Set<ZSetOperations.TypedTuple<V>>	rangeWithScores(K key, long start, long end) Get set of RedisZSetCommands.Tuples between start and end from sorted set.
Long	rank(K key, Object o) Determine the index of element with value in a sorted set.
Long	remove(K key, Object... values) Remove values from sorted set.
Long	removeRange(K key, long start, long end) Remove elements in range between start and end from sorted set with key.
Long	removeRangeByScore(K key, double min, double max) Remove elements with scores between min and max from sorted set with key.
Set<V>	reverseRange(K key, long start, long end) Get elements in range from start to end from sorted set ordered from high to low.
Set<V>	reverseRangeByScore(K key, double min, double max) Get elements where score is between min and max from sorted set ordered from high to low.
Set<V>	reverseRangeByScore(K key, double min, double max, long offset, long count) Get elements in range from start to end where score is between min and max from sorted set ordered high -> low.
Set<ZSetOperations.TypedTuple<V>>	reverseRangeByScoreWithScores(K key, double min, double max) Get set of RedisZSetCommands.Tuple where score is between min and max from sorted set ordered from high to low.
Set<ZSetOperations.TypedTuple<V>>	reverseRangeByScoreWithScores(K key, double min, double max, long offset, long count) Get set of RedisZSetCommands.Tuple in range from start to end where score is between min and max from sorted set ordered high -> low.
Set<ZSetOperations.TypedTuple<V>>	reverseRangeWithScores(K key, long start, long end) Get set of RedisZSetCommands.Tuples in range from start to end from sorted set ordered from high to low.
Long	reverseRank(K key, Object o) Determine the index of element with value in a sorted set when scored high to low.
Cursor<ZSetOperations.TypedTuple<V>>	scan(K key, ScanOptions options) Iterate over elements in zset at key.
Double	score(K key, Object o) Get the score of element with value from sorted set with key key.
Long	size(K key) Returns the number of elements of the sorted set stored with given key.
Long	unionAndStore(K key, Collection<K> otherKeys, K destKey) Union sorted sets at key and otherKeys and store result in destination destKey.
default Long	unionAndStore(K key, Collection<K> otherKeys, K destKey, RedisZSetCommands.Aggregate aggregate) Union sorted sets at key and otherKeys and store result in destination destKey.
Long	unionAndStore(K key, Collection<K> otherKeys, K destKey, RedisZSetCommands.Aggregate aggregate, RedisZSetCommands.Weights weights) Union sorted sets at key and otherKeys and store result in destination destKey.
Long	unionAndStore(K key, K otherKey, K destKey) Union sorted sets at key and otherKeys and store result in destination destKey.
Long	zCard(K key) Get the size of sorted set with key.

Method Detail

add

@Nullable
Boolean add(K key,
                      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.

score - the score.

value - the value.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZADD

add

@Nullable
Long add(K key,
                   Set<ZSetOperations.TypedTuple<V>> tuples)

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

Parameters:

key - must not be null.

tuples - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZADD

remove

@Nullable
Long remove(K key,
                      Object... values)

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

Parameters:

key - must not be null.

values - must not be null.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREM

incrementScore

@Nullable
Double incrementScore(K key,
                                V value,
                                double delta)

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

Parameters:

key - must not be null.

delta -

value - the value.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZINCRBY

rank

@Nullable
Long rank(K key,
                    Object o)

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

Parameters:

key - must not be null.

o - the value.

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANK

reverseRank

@Nullable
Long reverseRank(K key,
                           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:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANK

range

@Nullable
Set<V> range(K key,
                       long start,
                       long end)

Get elements between start and end from sorted set.

Parameters:

key - must not be null.

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGE

rangeWithScores

@Nullable
Set<ZSetOperations.TypedTuple<V>> rangeWithScores(K key,
                                                            long start,
                                                            long end)

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

Parameters:

key - must not be null.

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGE

rangeByScore

@Nullable
Set<V> rangeByScore(K key,
                              double min,
                              double max)

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

Parameters:

key - must not be null.

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGEBYSCORE

rangeByScoreWithScores

@Nullable
Set<ZSetOperations.TypedTuple<V>> rangeByScoreWithScores(K key,
                                                                   double min,
                                                                   double max)

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

Parameters:

key - must not be null.

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGEBYSCORE

rangeByScore

@Nullable
Set<V> rangeByScore(K key,
                              double min,
                              double max,
                              long offset,
                              long count)

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

Parameters:

key - must not be null.

min -

max -

offset -

count -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGEBYSCORE

rangeByScoreWithScores

@Nullable
Set<ZSetOperations.TypedTuple<V>> rangeByScoreWithScores(K key,
                                                                   double min,
                                                                   double max,
                                                                   long offset,
                                                                   long count)

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

Parameters:

key -

min -

max -

offset -

count -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZRANGEBYSCORE

reverseRange

@Nullable
Set<V> reverseRange(K key,
                              long start,
                              long end)

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

Parameters:

key - must not be null.

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGE

reverseRangeWithScores

@Nullable
Set<ZSetOperations.TypedTuple<V>> reverseRangeWithScores(K key,
                                                                   long start,
                                                                   long end)

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

Parameters:

key - must not be null.

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGE

reverseRangeByScore

@Nullable
Set<V> reverseRangeByScore(K key,
                                     double min,
                                     double max)

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

Parameters:

key - must not be null.

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGEBYSCORE

reverseRangeByScoreWithScores

@Nullable
Set<ZSetOperations.TypedTuple<V>> reverseRangeByScoreWithScores(K key,
                                                                          double min,
                                                                          double max)

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

Parameters:

key - must not be null.

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGEBYSCORE

reverseRangeByScore

@Nullable
Set<V> reverseRangeByScore(K key,
                                     double min,
                                     double max,
                                     long offset,
                                     long count)

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.

min -

max -

offset -

count -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGEBYSCORE

reverseRangeByScoreWithScores

@Nullable
Set<ZSetOperations.TypedTuple<V>> reverseRangeByScoreWithScores(K key,
                                                                          double min,
                                                                          double max,
                                                                          long offset,
                                                                          long count)

Get set of RedisZSetCommands.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.

min -

max -

offset -

count -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREVRANGEBYSCORE

count

@Nullable
Long count(K key,
                     double min,
                     double max)

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

Parameters:

key - must not be null.

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZCOUNT

size

@Nullable
Long size(K key)

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

Parameters:

key -

Returns:

null when used in pipeline / transaction.

See Also:

zCard(Object), Redis Documentation: ZCARD

zCard

@Nullable
Long zCard(K key)

Get the size of sorted set with key.

Parameters:

key - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

1.3

See Also:

Redis Documentation: ZCARD

score

@Nullable
Double score(K key,
                       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:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZSCORE

removeRange

@Nullable
Long removeRange(K key,
                           long start,
                           long end)

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

Parameters:

key - must not be null.

start -

end -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREMRANGEBYRANK

removeRangeByScore

@Nullable
Long removeRangeByScore(K key,
                                  double min,
                                  double max)

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

Parameters:

key - must not be null.

min -

max -

Returns:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZREMRANGEBYSCORE

unionAndStore

@Nullable
Long unionAndStore(K key,
                             K otherKey,
                             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:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZUNIONSTORE

unionAndStore

@Nullable
Long unionAndStore(K key,
                             Collection<K> otherKeys,
                             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:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZUNIONSTORE

unionAndStore

@Nullable
default Long unionAndStore(K key,
                                     Collection<K> otherKeys,
                                     K destKey,
                                     RedisZSetCommands.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:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: ZUNIONSTORE

unionAndStore

@Nullable
Long unionAndStore(K key,
                             Collection<K> otherKeys,
                             K destKey,
                             RedisZSetCommands.Aggregate aggregate,
                             RedisZSetCommands.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:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: ZUNIONSTORE

intersectAndStore

@Nullable
Long intersectAndStore(K key,
                                 K otherKey,
                                 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:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZINTERSTORE

intersectAndStore

@Nullable
Long intersectAndStore(K key,
                                 Collection<K> otherKeys,
                                 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:

null when used in pipeline / transaction.

See Also:

Redis Documentation: ZINTERSTORE

intersectAndStore

@Nullable
default Long intersectAndStore(K key,
                                         Collection<K> otherKeys,
                                         K destKey,
                                         RedisZSetCommands.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:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: ZINTERSTORE

intersectAndStore

@Nullable
Long intersectAndStore(K key,
                                 Collection<K> otherKeys,
                                 K destKey,
                                 RedisZSetCommands.Aggregate aggregate,
                                 RedisZSetCommands.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:

null when used in pipeline / transaction.

Since:

2.1

See Also:

Redis Documentation: ZINTERSTORE

scan

Cursor<ZSetOperations.TypedTuple<V>> scan(K key,
                                          ScanOptions options)

Iterate over elements in zset at key.
Important: Call Closeable.close() when done to avoid resource leak.

Parameters:

key -

options -

Returns:

null when used in pipeline / transaction.

Since:

1.4

See Also:

Redis Documentation: ZSCAN

rangeByLex

@Nullable
Set<V> rangeByLex(K key,
                            RedisZSetCommands.Range range)

Get all elements with lexicographical ordering from ZSET at key with a value between RedisZSetCommands.Range.getMin() and RedisZSetCommands.Range.getMax().

Parameters:

key - must not be null.

range - must not be null.

Returns:

null when used in pipeline / transaction.

Since:

1.7

See Also:

Redis Documentation: ZRANGEBYLEX

rangeByLex

@Nullable
Set<V> rangeByLex(K key,
                            RedisZSetCommands.Range range,
                            RedisZSetCommands.Limit limit)

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

Parameters:

key - must not be null

range - must not be null.

limit - can be null.

Returns:

null when used in pipeline / transaction.

Since:

1.7

See Also:

Redis Documentation: ZRANGEBYLEX

getOperations

RedisOperations<K,V> getOperations()

Returns:

never null.