All Superinterfaces:: BoundKeyOperations<K>

public interface BoundZSetOperations<K,V> extends BoundKeyOperations<K>

ZSet (or SortedSet) operations bound to a certain key.

Author:: Costin Leau, Christoph Strobl, Mark Paluch, Wongoo (望哥), Andrey Shlykov

Method Summary

Modifier and Type

Method

Description

Long

add(Set<ZSetOperations.TypedTuple<V>> tuples)

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

Boolean

add(V value, double score)

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

Long

addIfAbsent(Set<ZSetOperations.TypedTuple<V>> tuples)

Add tuples to a sorted set at the bound key if it does not already exists.

Boolean

addIfAbsent(V value, double score)

Add value to a sorted set at the bound key if it does not already exists.

Long

count(double min, double max)

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

Set<V>

difference(Collection<K> otherKeys)

Diff sorted sets.

default Set<V>

difference(K otherKey)

Diff sorted sets.

Long

differenceAndStore(Collection<K> otherKeys, K destKey)

Diff sorted sets and store result in destination destKey.

default Long

differenceAndStore(K otherKey, K destKey)

Diff sorted sets and store result in destination destKey.

Set<ZSetOperations.TypedTuple<V>>

differenceWithScores(Collection<K> otherKeys)

Diff sorted sets.

default Set<ZSetOperations.TypedTuple<V>>

differenceWithScores(K otherKey)

Diff sorted sets.

Set<V>

distinctRandomMembers(long count)

Get count distinct random elements from set at the bound key.

Set<ZSetOperations.TypedTuple<V>>

distinctRandomMembersWithScore(long count)

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

RedisOperations<K,V>

getOperations()

Double

incrementScore(V value, double delta)

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

Set<V>

intersect(Collection<K> otherKeys)

Intersect sorted sets.

default Set<V>

intersect(K otherKey)

Intersect sorted sets.

Long

intersectAndStore(Collection<K> otherKeys, K destKey)

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

Long

intersectAndStore(Collection<K> otherKeys, K destKey, Aggregate aggregate)

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

Long

intersectAndStore(Collection<K> otherKeys, K destKey, Aggregate aggregate, Weights weights)

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

Long

intersectAndStore(K otherKey, K destKey)

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

Set<ZSetOperations.TypedTuple<V>>

intersectWithScores(Collection<K> otherKeys)

Intersect sorted sets.

Set<ZSetOperations.TypedTuple<V>>

intersectWithScores(Collection<K> otherKeys, Aggregate aggregate, Weights weights)

Intersect sorted sets.

default Set<ZSetOperations.TypedTuple<V>>

intersectWithScores(K otherKey)

Intersect sorted sets.

Long

lexCount(Range<String> range)

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

default Long

lexCount(RedisZSetCommands.Range range)

Deprecated, for removal: This API element is subject to removal in a future version.
since 3.0.

ZSetOperations.TypedTuple<V>

popMax()

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

Set<ZSetOperations.TypedTuple<V>>

popMax(long count)

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

ZSetOperations.TypedTuple<V>

popMax(long timeout, TimeUnit unit)

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

default ZSetOperations.TypedTuple<V>

popMax(Duration timeout)

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

ZSetOperations.TypedTuple<V>

popMin()

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

Set<ZSetOperations.TypedTuple<V>>

popMin(long count)

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

ZSetOperations.TypedTuple<V>

popMin(long timeout, TimeUnit unit)

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

default ZSetOperations.TypedTuple<V>

popMin(Duration timeout)

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

V

randomMember()

Get random element from set at the bound key.

List<V>

randomMembers(long count)

Get count random elements from set at the bound key.

List<ZSetOperations.TypedTuple<V>>

randomMembersWithScore(long count)

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

ZSetOperations.TypedTuple<V>

randomMemberWithScore()

Get random element with its score from set at the bound key.

Set<V>

range(long start, long end)

Get elements between start and end from sorted set.

default Long

rangeAndStoreByLex(K dstKey, Range<String> range)

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

Long

rangeAndStoreByLex(K dstKey, Range<String> range, Limit limit)

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

default Long

rangeAndStoreByScore(K dstKey, Range<? extends Number> range)

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

Long

rangeAndStoreByScore(K dstKey, Range<? extends Number> range, Limit limit)

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

default Set<V>

rangeByLex(Range<String> range)

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

Set<V>

rangeByLex(Range<String> range, Limit limit)

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

default Set<V>

rangeByLex(RedisZSetCommands.Range range)

Deprecated, for removal: This API element is subject to removal in a future version.
since 3.0.

default Set<V>

rangeByLex(RedisZSetCommands.Range range, Limit limit)

Deprecated, for removal: This API element is subject to removal in a future version.
since 3.0.

Set<V>

rangeByScore(double min, double max)

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

Set<ZSetOperations.TypedTuple<V>>

rangeByScoreWithScores(double min, double max)

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

Set<ZSetOperations.TypedTuple<V>>

rangeWithScores(long start, long end)

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

Long

rank(Object o)

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

Long

remove(Object... values)

Remove values from sorted set.

Long

removeRange(long start, long end)

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

Long

removeRangeByLex(Range<String> range)

Remove elements in Range from sorted set with the bound key.

default Long

removeRangeByLex(RedisZSetCommands.Range range)

Deprecated, for removal: This API element is subject to removal in a future version.
since 3.0.

Long

removeRangeByScore(double min, double max)

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

Set<V>

reverseRange(long start, long end)

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

default Long

reverseRangeAndStoreByLex(K dstKey, Range<String> range)

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

Long

reverseRangeAndStoreByLex(K dstKey, Range<String> range, Limit limit)

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

default Long

reverseRangeAndStoreByScore(K dstKey, Range<? extends Number> range)

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

Long

reverseRangeAndStoreByScore(K dstKey, Range<? extends Number> range, Limit limit)

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

default Set<V>

reverseRangeByLex(Range<String> range)

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

Set<V>

reverseRangeByLex(Range<String> range, Limit limit)

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

default Set<V>

reverseRangeByLex(RedisZSetCommands.Range range)

Deprecated, for removal: This API element is subject to removal in a future version.
since 3.0.

default Set<V>

reverseRangeByLex(RedisZSetCommands.Range range, Limit limit)

Deprecated, for removal: This API element is subject to removal in a future version.
since 3.0.

Set<V>

reverseRangeByScore(double min, double max)

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

Set<ZSetOperations.TypedTuple<V>>

reverseRangeByScoreWithScores(double min, double max)

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

Set<ZSetOperations.TypedTuple<V>>

reverseRangeWithScores(long start, long end)

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

Long

reverseRank(Object o)

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

Cursor<ZSetOperations.TypedTuple<V>>

scan(ScanOptions options)

Use a Cursor to iterate over entries in zset at the bound key.

Double

score(Object o)

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

List<Double>

score(Object... o)

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

Long

size()

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

Set<V>

union(Collection<K> otherKeys)

Union sorted sets.

default Set<V>

union(K otherKey)

Union sorted sets.

Long

unionAndStore(Collection<K> otherKeys, K destKey)

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

Long

unionAndStore(Collection<K> otherKeys, K destKey, Aggregate aggregate)

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

Long

unionAndStore(Collection<K> otherKeys, K destKey, Aggregate aggregate, Weights weights)

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

Long

unionAndStore(K otherKey, K destKey)

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

Set<ZSetOperations.TypedTuple<V>>

unionWithScores(Collection<K> otherKeys)

Union sorted sets.

default Set<ZSetOperations.TypedTuple<V>>

unionWithScores(Collection<K> otherKeys, Aggregate aggregate)

Union sorted sets at the bound key and otherKeys.

Set<ZSetOperations.TypedTuple<V>>

unionWithScores(Collection<K> otherKeys, Aggregate aggregate, Weights weights)

Union sorted sets.

default Set<ZSetOperations.TypedTuple<V>>

unionWithScores(K otherKey)

Union sorted sets.

Long

zCard()

Get the size of sorted set with the bound key.

Methods inherited from interface org.springframework.data.redis.core.BoundKeyOperations
expire, expire, expireAt, expireAt, getExpire, getKey, getType, persist, rename

Method Details
- add
  
  @Nullable Boolean add(V value, double score)
  
  Add value to a sorted set at the bound key, or update its score if it already exists.
  Parameters:
  
  value - the value.
  
  score - the score.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZADD
- addIfAbsent
  
  @Nullable Boolean addIfAbsent(V value, double score)
  
  Add value to a sorted set at the bound key if it does not already exists.
  Parameters:
  
  value - the value.
  
  score - the score.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.5
  
  See Also:
  
  Redis Documentation: ZADD NX
- add
  
  @Nullable Long add(Set<ZSetOperations.TypedTuple<V>> tuples)
  
  Add tuples to a sorted set at the bound key, or update its score if it already exists.
  Parameters:
  
  tuples - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZADD
- addIfAbsent
  
  @Nullable Long addIfAbsent(Set<ZSetOperations.TypedTuple<V>> tuples)
  
  Add tuples to a sorted set at the bound key if it does not already exists.
  Parameters:
  
  tuples - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.5
  
  See Also:
  
  Redis Documentation: ZADD NX
- remove
  
  @Nullable Long remove(Object... values)
  
  Remove values from sorted set. Return number of removed elements.
  Parameters:
  
  values - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZREM
- incrementScore
  
  @Nullable Double incrementScore(V value, double delta)
  
  Increment the score of element with value in sorted set by increment.
  Parameters:
  
  value - the value.
  
  delta - the delta to add. Can be negative.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZINCRBY
- randomMember
  
  V randomMember()
  
  Get random element from set at the bound key.
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZRANDMEMBER
- distinctRandomMembers
  
  @Nullable Set<V> distinctRandomMembers(long count)
  
  Get count distinct random elements from set at the bound key.
  Parameters:
  
  count - number of members to return.
  
  Returns:
  
  empty Set if key does not exist.
  
  Throws:
  
  IllegalArgumentException - if count is negative.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZRANDMEMBER
- randomMembers
  
  @Nullable List<V> randomMembers(long count)
  
  Get count random elements from set at the bound key.
  Parameters:
  
  count - number of members to return.
  
  Returns:
  
  empty List if key does not exist or null when used in pipeline / transaction.
  
  Throws:
  
  IllegalArgumentException - if count is negative.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZRANDMEMBER
- randomMemberWithScore
  
  ZSetOperations.TypedTuple<V> randomMemberWithScore()
  
  Get random element with its score from set at the bound key.
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZRANDMEMBER
- distinctRandomMembersWithScore
  
  @Nullable Set<ZSetOperations.TypedTuple<V>> distinctRandomMembersWithScore(long count)
  
  Get count distinct random elements with their score from set at the bound key.
  Parameters:
  
  count - number of members to return.
  
  Returns:
  
  empty Set if key does not exist.
  
  Throws:
  
  IllegalArgumentException - if count is negative.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZRANDMEMBER
- randomMembersWithScore
  
  @Nullable List<ZSetOperations.TypedTuple<V>> randomMembersWithScore(long count)
  
  Get count random elements with their score from set at the bound key.
  Parameters:
  
  count - number of members to return.
  
  Returns:
  
  empty List if key does not exist or null when used in pipeline / transaction.
  
  Throws:
  
  IllegalArgumentException - if count is negative.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZRANDMEMBER
- rank
  
  @Nullable Long rank(Object o)
  
  Determine the index of element with value in a sorted set.
  Parameters:
  
  o - the value.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZRANK
- reverseRank
  
  @Nullable Long reverseRank(Object o)
  
  Determine the index of element with value in a sorted set when scored high to low.
  Parameters:
  
  o - the value.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZREVRANK
- range
  
  @Nullable Set<V> range(long start, long end)
  
  Get elements between start and end from sorted set.
  Parameters:
  
  start -
  
  end -
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZRANGE
- rangeWithScores
  
  @Nullable Set<ZSetOperations.TypedTuple<V>> rangeWithScores(long start, long end)
  
  Get set of Tuples between start and end from sorted set.
  Parameters:
  
  start -
  
  end -
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZRANGE
- rangeByScore
  
  @Nullable Set<V> rangeByScore(double min, double max)
  
  Get elements where score is between min and max from sorted set.
  Parameters:
  
  min -
  
  max -
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZRANGEBYSCORE
- rangeByScoreWithScores
  
  @Nullable Set<ZSetOperations.TypedTuple<V>> rangeByScoreWithScores(double min, double max)
  
  Get set of Tuples where score is between min and max from sorted set.
  Parameters:
  
  min -
  
  max -
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZRANGEBYSCORE
- reverseRange
  
  @Nullable Set<V> reverseRange(long start, long end)
  
  Get elements in range from start to end from sorted set ordered from high to low.
  Parameters:
  
  start -
  
  end -
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZREVRANGE
- reverseRangeWithScores
  
  @Nullable Set<ZSetOperations.TypedTuple<V>> reverseRangeWithScores(long start, long end)
  
  Get set of Tuples in range from start to end from sorted set ordered from high to low.
  Parameters:
  
  start -
  
  end -
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZREVRANGE
- reverseRangeByScore
  
  @Nullable Set<V> reverseRangeByScore(double min, double max)
  
  Get elements where score is between min and max from sorted set ordered from high to low.
  Parameters:
  
  min -
  
  max -
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZREVRANGEBYSCORE
- reverseRangeByScoreWithScores
  
  @Nullable Set<ZSetOperations.TypedTuple<V>> reverseRangeByScoreWithScores(double min, double max)
  
  Get set of Tuple where score is between min and max from sorted set ordered from high to low.
  Parameters:
  
  min -
  
  max -
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZREVRANGEBYSCORE
- count
  
  @Nullable Long count(double min, double max)
  
  Count number of elements within sorted set with scores between min and max.
  Parameters:
  
  min -
  
  max -
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZCOUNT
- lexCount
  
  @Nullable @Deprecated(since="3.0", forRemoval=true) default Long lexCount(RedisZSetCommands.Range range)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  since 3.0. Please use lexCount(Range) instead.
  
  Count number of elements within sorted set with value between Range#min and Range#max applying lexicographical ordering.
  Parameters:
  
  range - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.4
  
  See Also:
  
  Redis Documentation: ZLEXCOUNT
- lexCount
  
  @Nullable Long lexCount(Range<String> range)
  
  Count number of elements within sorted set with value between Range.getLowerBound() and Range.getUpperBound() applying lexicographical ordering.
  Parameters:
  
  range - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  Redis Documentation: ZLEXCOUNT
- popMin
  
  @Nullable ZSetOperations.TypedTuple<V> popMin()
  
  Remove and return the value with its score having the lowest score from sorted set at the bound key.
  Returns:
  
  null when the sorted set is empty or used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZPOPMIN
- popMin
  
  @Nullable Set<ZSetOperations.TypedTuple<V>> popMin(long count)
  
  Remove and return count values with their score having the lowest score from sorted set at the bound key.
  Parameters:
  
  count - number of elements to pop.
  
  Returns:
  
  null when the sorted set is empty or used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZPOPMIN
- popMin
  
  @Nullable ZSetOperations.TypedTuple<V> popMin(long timeout, TimeUnit unit)
  
  Remove and return the value with its score having the lowest score from sorted set at the bound key. Blocks connection until element available or timeout reached.
  Parameters:
  
  timeout -
  
  unit - must not be null.
  
  Returns:
  
  can be null.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: BZPOPMIN
- popMin
  
  @Nullable default ZSetOperations.TypedTuple<V> popMin(Duration timeout)
  
  Remove and return the value with its score having the lowest score from sorted set at the bound key. Blocks connection until element available or timeout reached.
  Parameters:
  
  timeout - must not be null.
  
  Returns:
  
  can be null.
  
  Throws:
  
  IllegalArgumentException - if the timeout is null or negative.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: BZPOPMIN
- popMax
  
  @Nullable ZSetOperations.TypedTuple<V> popMax()
  
  Remove and return the value with its score having the highest score from sorted set at the bound key.
  Returns:
  
  null when the sorted set is empty or used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZPOPMAX
- popMax
  
  @Nullable Set<ZSetOperations.TypedTuple<V>> popMax(long count)
  
  Remove and return count values with their score having the highest score from sorted set at the bound key.
  Parameters:
  
  count - number of elements to pop.
  
  Returns:
  
  null when the sorted set is empty or used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZPOPMAX
- popMax
  
  @Nullable ZSetOperations.TypedTuple<V> popMax(long timeout, TimeUnit unit)
  
  Remove and return the value with its score having the highest score from sorted set at the bound key. Blocks connection until element available or timeout reached.
  Parameters:
  
  timeout -
  
  unit - must not be null.
  
  Returns:
  
  can be null.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: BZPOPMAX
- popMax
  
  @Nullable default ZSetOperations.TypedTuple<V> popMax(Duration timeout)
  
  Remove and return the value with its score having the highest score from sorted set at the bound key. Blocks connection until element available or timeout reached.
  Parameters:
  
  timeout - must not be null.
  
  Returns:
  
  can be null.
  
  Throws:
  
  IllegalArgumentException - if the timeout is null or negative.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: BZPOPMAX
- size
  
  @Nullable Long size()
  
  Returns the number of elements of the sorted set stored with given the bound key.
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  zCard()
  
  Redis Documentation: ZCARD
- zCard
  
  @Nullable Long zCard()
  
  Get the size of sorted set with the bound key.
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  1.3
  
  See Also:
  
  Redis Documentation: ZCARD
- score
  
  @Nullable Double score(Object o)
  
  Get the score of element with value from sorted set with key the bound key.
  Parameters:
  
  o - the value.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZSCORE
- score
  
  @Nullable List<Double> score(Object... o)
  
  Get the scores of elements with values from sorted set with key the bound key.
  Parameters:
  
  o - the values.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZMSCORE
- removeRange
  
  @Nullable Long removeRange(long start, long end)
  
  Remove elements in range between start and end from sorted set with the bound key.
  Parameters:
  
  start -
  
  end -
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZREMRANGEBYRANK
- removeRangeByLex
  
  @Nullable @Deprecated(since="3.0", forRemoval=true) default Long removeRangeByLex(RedisZSetCommands.Range range)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  since 3.0. Please use removeRangeByLex(Range).
  
  Remove elements in Range from sorted set with the bound key.
  Parameters:
  
  range - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.5
  
  See Also:
  
  Redis Documentation: ZREMRANGEBYLEX
- removeRangeByLex
  
  @Nullable Long removeRangeByLex(Range<String> range)
  
  Remove elements in Range from sorted set with the bound key.
  Parameters:
  
  range - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  Redis Documentation: ZREMRANGEBYLEX
- removeRangeByScore
  
  @Nullable Long removeRangeByScore(double min, double max)
  
  Remove elements with scores between min and max from sorted set with the bound key.
  Parameters:
  
  min -
  
  max -
  
  Returns:
  
  null when used in pipeline / transaction.
  
  See Also:
  
  Redis Documentation: ZREMRANGEBYSCORE
- unionAndStore
  
  @Nullable Long unionAndStore(Collection<K> otherKeys, K destKey, Aggregate aggregate, Weights weights)
  
  Union sorted sets at the bound key and otherKeys and store result in destination destKey.
  Parameters:
  
  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
- difference
  
  @Nullable default Set<V> difference(K otherKey)
  
  Diff sorted sets.
  Parameters:
  
  otherKey - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZDIFF
- difference
  
  @Nullable Set<V> difference(Collection<K> otherKeys)
  
  Diff sorted sets.
  Parameters:
  
  otherKeys - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZDIFF
- differenceWithScores
  
  @Nullable default Set<ZSetOperations.TypedTuple<V>> differenceWithScores(K otherKey)
  
  Diff sorted sets.
  Parameters:
  
  otherKey - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZDIFF
- differenceWithScores
  
  @Nullable Set<ZSetOperations.TypedTuple<V>> differenceWithScores(Collection<K> otherKeys)
  
  Diff sorted sets.
  Parameters:
  
  otherKeys - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZDIFF
- differenceAndStore
  
  @Nullable default Long differenceAndStore(K otherKey, K destKey)
  
  Diff sorted sets and store result in destination destKey.
  Parameters:
  
  otherKey - must not be null.
  
  destKey - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZDIFFSTORE
- differenceAndStore
  
  @Nullable Long differenceAndStore(Collection<K> otherKeys, K destKey)
  
  Diff sorted sets and store result in destination destKey.
  Parameters:
  
  otherKeys - must not be null.
  
  destKey - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZDIFFSTORE
- intersect
  
  @Nullable default Set<V> intersect(K otherKey)
  
  Intersect sorted sets.
  Parameters:
  
  otherKey - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZINTER
- intersect
  
  @Nullable Set<V> intersect(Collection<K> otherKeys)
  
  Intersect sorted sets.
  Parameters:
  
  otherKeys - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZINTER
- intersectWithScores
  
  @Nullable default Set<ZSetOperations.TypedTuple<V>> intersectWithScores(K otherKey)
  
  Intersect sorted sets.
  Parameters:
  
  otherKey - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZINTER
- intersectWithScores
  
  @Nullable Set<ZSetOperations.TypedTuple<V>> intersectWithScores(Collection<K> otherKeys)
  
  Intersect sorted sets.
  Parameters:
  
  otherKeys - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZINTER
- intersectWithScores
  
  @Nullable Set<ZSetOperations.TypedTuple<V>> intersectWithScores(Collection<K> otherKeys, Aggregate aggregate, Weights weights)
  
  Intersect sorted sets.
  Parameters:
  
  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
  
  @Nullable Long intersectAndStore(K otherKey, K destKey)
  
  Intersect sorted sets at the bound key and otherKey and store result in destination destKey.
  Parameters:
  
  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(Collection<K> otherKeys, K destKey)
  
  Intersect sorted sets at the bound key and otherKeys and store result in destination destKey.
  Parameters:
  
  otherKeys - 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(Collection<K> otherKeys, K destKey, Aggregate aggregate)
  
  Intersect sorted sets at the bound key and otherKeys and store result in destination destKey.
  Parameters:
  
  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(Collection<K> otherKeys, K destKey, Aggregate aggregate, Weights weights)
  
  Intersect sorted sets at the bound key and otherKeys and store result in destination destKey.
  Parameters:
  
  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
- union
  
  @Nullable default Set<V> union(K otherKey)
  
  Union sorted sets.
  Parameters:
  
  otherKey - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZUNION
- union
  
  @Nullable Set<V> union(Collection<K> otherKeys)
  
  Union sorted sets.
  Parameters:
  
  otherKeys - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZUNION
- unionWithScores
  
  @Nullable default Set<ZSetOperations.TypedTuple<V>> unionWithScores(K otherKey)
  
  Union sorted sets.
  Parameters:
  
  otherKey - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZUNION
- unionWithScores
  
  @Nullable Set<ZSetOperations.TypedTuple<V>> unionWithScores(Collection<K> otherKeys)
  
  Union sorted sets.
  Parameters:
  
  otherKeys - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZUNION
- unionWithScores
  
  @Nullable default Set<ZSetOperations.TypedTuple<V>> unionWithScores(Collection<K> otherKeys, Aggregate aggregate)
  
  Union sorted sets at the bound key and otherKeys.
  Parameters:
  
  otherKeys - must not be null.
  
  aggregate - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZUNION
- unionWithScores
  
  @Nullable Set<ZSetOperations.TypedTuple<V>> unionWithScores(Collection<K> otherKeys, Aggregate aggregate, Weights weights)
  
  Union sorted sets.
  Parameters:
  
  otherKeys - must not be null.
  
  aggregate - must not be null.
  
  weights - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.6
  
  See Also:
  
  Redis Documentation: ZUNION
- unionAndStore
  
  @Nullable Long unionAndStore(K otherKey, K destKey)
  
  Union sorted sets at the bound key and otherKeys and store result in destination destKey.
  Parameters:
  
  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(Collection<K> otherKeys, K destKey)
  
  Union sorted sets at the bound key and otherKeys and store result in destination destKey.
  Parameters:
  
  otherKeys - 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(Collection<K> otherKeys, K destKey, Aggregate aggregate)
  
  Union sorted sets at the bound key and otherKeys and store result in destination destKey.
  Parameters:
  
  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
- scan
  
  Cursor<ZSetOperations.TypedTuple<V>> scan(ScanOptions options)
  
  Use a Cursor to iterate over entries in zset at the bound key.
  Important: Call CloseableIterator.close() when done to avoid resource leaks.
  
  Parameters:
  
  options - must not be null.
  
  Returns:
  
  the result cursor providing access to the scan result. Must be closed once fully processed (e.g. through a try-with-resources clause).
  
  Since:
  
  1.4
- rangeByLex
  
  @Nullable @Deprecated(since="3.0", forRemoval=true) default Set<V> rangeByLex(RedisZSetCommands.Range range)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  since 3.0. Please use rangeByLex(Range) instead.
  
  Get all elements with lexicographical ordering with a value between RedisZSetCommands.Range.getMin() and RedisZSetCommands.Range.getMax().
  Parameters:
  
  range - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  1.7
  
  See Also:
  
  Redis Documentation: ZRANGEBYLEX
- rangeByLex
  
  @Nullable default Set<V> rangeByLex(Range<String> range)
  
  Get all elements with lexicographical ordering with a value between Range.getLowerBound() and Range.getUpperBound().
  Parameters:
  
  range - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  Redis Documentation: ZRANGEBYLEX
- rangeByLex
  
  @Nullable @Deprecated(since="3.0", forRemoval=true) default Set<V> rangeByLex(RedisZSetCommands.Range range, Limit limit)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  since 3.0. Please use rangeByLex(Range, Limit) instead.
  
  Get all elements n elements, where n = Limit.getCount(), starting at Limit.getOffset() with lexicographical ordering from ZSET at key with a value between RedisZSetCommands.Range.getMin() and RedisZSetCommands.Range.getMax().
  Parameters:
  
  range - must not be null.
  
  limit - can be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  1.7
  
  See Also:
  
  Redis Documentation: ZRANGEBYLEX
- rangeByLex
  
  @Nullable Set<V> rangeByLex(Range<String> range, Limit limit)
  
  Get all elements n elements, where n = Limit.getCount(), starting at Limit.getOffset() with lexicographical ordering having a value between Range.getLowerBound() and Range.getUpperBound().
  Parameters:
  
  range - must not be null.
  
  limit - can be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  Redis Documentation: ZRANGEBYLEX
- reverseRangeByLex
  
  @Nullable @Deprecated(since="3.0", forRemoval=true) default Set<V> reverseRangeByLex(RedisZSetCommands.Range range)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  since 3.0. Please use reverseRangeByLex(Range) instead.
  
  Get all elements with reverse lexicographical ordering from ZSET with a value between RedisZSetCommands.Range.getMin() and RedisZSetCommands.Range.getMax().
  Parameters:
  
  range - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.4
  
  See Also:
  
  Redis Documentation: ZREVRANGEBYLEX
- reverseRangeByLex
  
  @Nullable default Set<V> reverseRangeByLex(Range<String> range)
  
  Get all elements with reverse lexicographical ordering with a value between Range.getLowerBound() and Range.getUpperBound().
  Parameters:
  
  range - must not be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  Redis Documentation: ZREVRANGEBYLEX
- reverseRangeByLex
  
  @Nullable @Deprecated(since="3.0", forRemoval=true) default Set<V> reverseRangeByLex(RedisZSetCommands.Range range, Limit limit)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  since 3.0. Please use reverseRangeByLex(Range, Limit) instead.
  
  Get all elements n elements, where n = Limit.getCount(), starting at Limit.getOffset() with reverse lexicographical ordering from ZSET having a value between RedisZSetCommands.Range.getMin() and RedisZSetCommands.Range.getMax().
  Parameters:
  
  range - must not be null.
  
  limit - can be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  2.4
  
  See Also:
  
  Redis Documentation: ZREVRANGEBYLEX
- reverseRangeByLex
  
  @Nullable Set<V> reverseRangeByLex(Range<String> range, Limit limit)
  
  Get all elements n elements, where n = Limit.getCount(), starting at Limit.getOffset() with reverse lexicographical ordering having a value between Range.getLowerBound() and Range.getUpperBound().
  Parameters:
  
  range - must not be null.
  
  limit - can be null.
  
  Returns:
  
  null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  Redis Documentation: ZREVRANGEBYLEX
- rangeAndStoreByLex
  
  @Nullable default Long rangeAndStoreByLex(K dstKey, Range<String> range)
  
  Store all elements at dstKey with lexicographical ordering from ZSET at the bound key with a value between Range.getLowerBound() and Range.getUpperBound().
  Parameters:
  
  dstKey - must not be null.
  
  range - must not be null.
  
  Returns:
  
  the number of stored elements or null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  rangeByLex(Range)
  
  Redis Documentation: ZRANGESTORE
- rangeAndStoreByLex
  
  @Nullable Long rangeAndStoreByLex(K dstKey, Range<String> range, Limit limit)
  
  Store n elements at dstKey, where n = Limit.getCount(), starting at Limit.getOffset() with lexicographical ordering from ZSET at the bound key with a value between Range.getLowerBound() and Range.getUpperBound().
  Parameters:
  
  dstKey - must not be null.
  
  range - must not be null.
  
  limit - must not be null.
  
  Returns:
  
  the number of stored elements or null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  rangeByLex(Range, Limit)
  
  Redis Documentation: ZRANGESTORE
- reverseRangeAndStoreByLex
  
  @Nullable default Long reverseRangeAndStoreByLex(K dstKey, Range<String> range)
  
  Store all elements at dstKey with reverse lexicographical ordering from ZSET at the bound key with a value between Range.getLowerBound() and Range.getUpperBound().
  Parameters:
  
  dstKey - must not be null.
  
  range - must not be null.
  
  Returns:
  
  the number of stored elements or null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  reverseRangeByLex(Range)
  
  Redis Documentation: ZRANGESTORE
- reverseRangeAndStoreByLex
  
  @Nullable Long reverseRangeAndStoreByLex(K dstKey, Range<String> range, Limit limit)
  
  Store n elements at dstKey, where n = Limit.getCount(), starting at Limit.getOffset() with reverse lexicographical ordering from ZSET at the bound key with a value between Range.getLowerBound() and Range.getUpperBound().
  Parameters:
  
  dstKey - must not be null.
  
  range - must not be null.
  
  limit - must not be null.
  
  Returns:
  
  the number of stored elements or null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  reverseRangeByLex(Range, Limit)
  
  Redis Documentation: ZRANGESTORE
- rangeAndStoreByScore
  
  @Nullable default Long rangeAndStoreByScore(K dstKey, Range<? extends Number> range)
  
  Store all elements at dstKey with ordering by score from ZSET at the bound key with a score between Range.getLowerBound() and Range.getUpperBound().
  Parameters:
  
  dstKey - must not be null.
  
  range - must not be null.
  
  Returns:
  
  the number of stored elements or null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  rangeByScore(double, double)
  
  Redis Documentation: ZRANGESTORE
- rangeAndStoreByScore
  
  @Nullable Long rangeAndStoreByScore(K dstKey, Range<? extends Number> range, Limit limit)
  
  Store n elements at dstKey, where n = Limit.getCount(), starting at Limit.getOffset() with ordering by score from ZSET at the bound key with a score between Range.getLowerBound() and Range.getUpperBound().
  Parameters:
  
  dstKey - must not be null.
  
  range - must not be null.
  
  limit - must not be null.
  
  Returns:
  
  the number of stored elements or null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  rangeByScore(double, double)
  
  Redis Documentation: ZRANGESTORE
- reverseRangeAndStoreByScore
  
  @Nullable default Long reverseRangeAndStoreByScore(K dstKey, Range<? extends Number> range)
  
  Store all elements at dstKey with reverse ordering by score from ZSET at the bound key with a score between Range.getLowerBound() and Range.getUpperBound().
  Parameters:
  
  dstKey - must not be null.
  
  range - must not be null.
  
  Returns:
  
  the number of stored elements or null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  reverseRangeByScore(double, double)
  
  Redis Documentation: ZRANGESTORE
- reverseRangeAndStoreByScore
  
  @Nullable Long reverseRangeAndStoreByScore(K dstKey, Range<? extends Number> range, Limit limit)
  
  Store n elements at dstKey, where n = Limit.getCount(), starting at Limit.getOffset() with reverse ordering by score from ZSET at the bound key with a score between Range.getLowerBound() and Range.getUpperBound().
  Parameters:
  
  dstKey - must not be null.
  
  range - must not be null.
  
  limit - must not be null.
  
  Returns:
  
  the number of stored elements or null when used in pipeline / transaction.
  
  Since:
  
  3.0
  
  See Also:
  
  Redis Documentation: ZRANGESTORE
- getOperations
  
  RedisOperations<K,V> getOperations()
  
  Returns:
  
  never null.

Interface BoundZSetOperations<K,V>

Method Summary

Methods inherited from interface org.springframework.data.redis.core.BoundKeyOperations

Method Details

add

addIfAbsent

add

addIfAbsent

remove

incrementScore

randomMember

distinctRandomMembers

randomMembers

randomMemberWithScore

distinctRandomMembersWithScore

randomMembersWithScore

rank

reverseRank

range

rangeWithScores

rangeByScore

rangeByScoreWithScores

reverseRange

reverseRangeWithScores

reverseRangeByScore

reverseRangeByScoreWithScores

count

lexCount

lexCount

popMin

popMin

popMin

popMin

popMax

popMax

popMax

popMax

size

zCard

score

score

removeRange

removeRangeByLex

removeRangeByLex

removeRangeByScore

unionAndStore

difference

difference

differenceWithScores

differenceWithScores

differenceAndStore

differenceAndStore

intersect

intersect

intersectWithScores

intersectWithScores

intersectWithScores

intersectAndStore

intersectAndStore

intersectAndStore

intersectAndStore

union

union

unionWithScores

unionWithScores

unionWithScores

unionWithScores

unionAndStore

unionAndStore

unionAndStore

scan

rangeByLex

rangeByLex

rangeByLex

rangeByLex

reverseRangeByLex

reverseRangeByLex

reverseRangeByLex

reverseRangeByLex

rangeAndStoreByLex