Type Parameters:

K - the type of the key

V - the type of the scored item

All Superinterfaces:

RedisCommands

All Known Implementing Classes:

BlockingSortedSetCommandsImpl
```
public interface SortedSetCommands<K,V>
extends RedisCommands
```
Allows executing commands from the sorted set group. See the sorted set command list for further information about these commands.
A sorted set is a set of value associated with scores. These scores allow comparing the elements. As a result, we obtain a sorted set.
Scores are of type double.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`List<ScoredValue<V>>`	`bzmpopMax(Duration timeout, int count, K... keys)`	Execute the command BZMPOP.
`ScoredValue<V>`	`bzmpopMax(Duration timeout, K... keys)`	Execute the command BZMPOP.
`List<ScoredValue<V>>`	`bzmpopMin(Duration timeout, int count, K... keys)`	Execute the command BZMPOP.
`ScoredValue<V>`	`bzmpopMin(Duration timeout, K... keys)`	Execute the command BZMPOP.
`KeyValue<K,ScoredValue<V>>`	`bzpopmax(Duration timeout, K... keys)`	Execute the command BZPOPMAX.
`KeyValue<K,ScoredValue<V>>`	`bzpopmin(Duration timeout, K... keys)`	Execute the command BZPOPMIN.
`List<V>`	`sort(K key)`	Execute the command SORT.
`List<V>`	`sort(K key, SortArgs sortArguments)`	Execute the command SORT.
`long`	`sortAndStore(K key, K destination)`	Execute the command SORT with the `STORE` option.
`long`	`sortAndStore(K key, K destination, SortArgs sortArguments)`	Execute the command SORT with the `STORE` option.
`boolean`	`zadd(K key, double score, V member)`	Execute the command ZADD.
`int`	`zadd(K key, ScoredValue<V>... items)`	Execute the command ZADD.
`boolean`	`zadd(K key, ZAddArgs zAddArgs, double score, V member)`	Execute the command ZADD.
`int`	`zadd(K key, ZAddArgs zAddArgs, ScoredValue<V>... items)`	Execute the command ZADD.
`int`	`zadd(K key, ZAddArgs zAddArgs, Map<V,Double> items)`	Execute the command ZADD.
`int`	`zadd(K key, Map<V,Double> items)`	Execute the command ZADD.
`double`	`zaddincr(K key, double score, V member)`	Execute the command ZADD.
`OptionalDouble`	`zaddincr(K key, ZAddArgs zAddArgs, double score, V member)`	Execute the command ZADD.
`long`	`zcard(K key)`	Execute the command ZCARD.
`long`	`zcount(K key, ScoreRange<Double> range)`	Execute the command ZCOUNT.
`List<V>`	`zdiff(K... keys)`	Execute the command ZDIFF.
`long`	`zdiffstore(K destination, K... keys)`	Execute the command ZDIFFSTORE.
`List<ScoredValue<V>>`	`zdiffWithScores(K... keys)`	Execute the command ZDIFF.
`double`	`zincrby(K key, double increment, V member)`	Execute the command ZINCRBY.
`List<V>`	`zinter(ZAggregateArgs arguments, K... keys)`	Execute the command ZINTER.
`List<V>`	`zinter(K... keys)`	Execute the command ZINTER.
`long`	`zintercard(long limit, K... keys)`	Execute the command ZINTERCARD.
`long`	`zintercard(K... keys)`	Execute the command ZINTERCARD.
`long`	`zinterstore(K destination, ZAggregateArgs arguments, K... keys)`	Execute the command ZINTERSTORE.
`long`	`zinterstore(K destination, K... keys)`	Execute the command ZINTERSTORE.
`List<ScoredValue<V>>`	`zinterWithScores(ZAggregateArgs arguments, K... keys)`	Execute the command ZINTER.
`List<ScoredValue<V>>`	`zinterWithScores(K... keys)`	Execute the command ZINTER.
`long`	`zlexcount(K key, Range<String> range)`	Execute the command ZLEXCOUNT.
`List<ScoredValue<V>>`	`zmpopMax(int count, K... keys)`	Execute the command ZMPOP.
`ScoredValue<V>`	`zmpopMax(K... keys)`	Execute the command ZMPOP.
`List<ScoredValue<V>>`	`zmpopMin(int count, K... keys)`	Execute the command ZMPOP.
`ScoredValue<V>`	`zmpopMin(K... keys)`	Execute the command ZMPOP.
`List<OptionalDouble>`	`zmscore(K key, V... members)`	Execute the command ZMSCORE.
`ScoredValue<V>`	`zpopmax(K key)`	Execute the command ZPOPMAX.
`List<ScoredValue<V>>`	`zpopmax(K key, int count)`	Execute the command ZPOPMAX.
`ScoredValue<V>`	`zpopmin(K key)`	Execute the command ZPOPMIN.
`List<ScoredValue<V>>`	`zpopmin(K key, int count)`	Execute the command ZPOPMIN.
`V`	`zrandmember(K key)`	Execute the command ZRANDMEMBER.
`List<V>`	`zrandmember(K key, int count)`	Execute the command ZRANDMEMBER.
`ScoredValue<V>`	`zrandmemberWithScores(K key)`	Execute the command ZRANDMEMBER.
`List<ScoredValue<V>>`	`zrandmemberWithScores(K key, int count)`	Execute the command ZRANDMEMBER.
`List<V>`	`zrange(K key, long start, long stop)`	Execute the command ZRANGE.
`List<V>`	`zrange(K key, long start, long stop, ZRangeArgs args)`	Execute the command ZRANGE.
`List<V>`	`zrangebylex(K key, Range<String> range)`	Execute the command ZRANGE.
`List<V>`	`zrangebylex(K key, Range<String> range, ZRangeArgs args)`	Execute the command ZRANGE.
`List<V>`	`zrangebyscore(K key, ScoreRange<Double> range)`	Execute the command ZRANGE.
`List<V>`	`zrangebyscore(K key, ScoreRange<Double> range, ZRangeArgs args)`	Execute the command ZRANGE.
`List<ScoredValue<V>>`	`zrangebyscoreWithScores(K key, ScoreRange<Double> range)`	Execute the command ZRANGE.
`List<ScoredValue<V>>`	`zrangebyscoreWithScores(K key, ScoreRange<Double> range, ZRangeArgs args)`	Execute the command ZRANGE.
`long`	`zrangestore(K dst, K src, long min, long max)`	Execute the command ZRANGESTORE.
`long`	`zrangestore(K dst, K src, long min, long max, ZRangeArgs args)`	Execute the command ZRANGESTORE.
`long`	`zrangestorebylex(K dst, K src, Range<String> range)`	Execute the command ZRANGESTORE.
`long`	`zrangestorebylex(K dst, K src, Range<String> range, ZRangeArgs args)`	Execute the command ZRANGESTORE.
`long`	`zrangestorebyscore(K dst, K src, ScoreRange<Double> range)`	Execute the command ZRANGESTORE.
`long`	`zrangestorebyscore(K dst, K src, ScoreRange<Double> range, ZRangeArgs args)`	Execute the command ZRANGESTORE.
`List<ScoredValue<V>>`	`zrangeWithScores(K key, long start, long stop)`	Execute the command ZRANGE.
`List<ScoredValue<V>>`	`zrangeWithScores(K key, long start, long stop, ZRangeArgs args)`	Execute the command ZRANGE.
`OptionalLong`	`zrank(K key, V member)`	Execute the command ZRANK.
`int`	`zrem(K key, V... members)`	Execute the command ZREM.
`long`	`zremrangebylex(K key, Range<String> range)`	Execute the command ZREMRANGEBYLEX.
`long`	`zremrangebyrank(K key, long start, long stop)`	Execute the command ZREMRANGEBYRANK.
`long`	`zremrangebyscore(K key, ScoreRange<Double> range)`	Execute the command ZREMRANGEBYSCORE.
`OptionalLong`	`zrevrank(K key, V member)`	Execute the command ZREVRANK.
`ZScanCursor<V>`	`zscan(K key)`	Execute the command ZSCAN.
`ZScanCursor<V>`	`zscan(K key, ScanArgs args)`	Execute the command ZSCAN.
`OptionalDouble`	`zscore(K key, V member)`	Execute the command ZSCORE.
`List<V>`	`zunion(ZAggregateArgs args, K... keys)`	Execute the command ZUNION.
`List<V>`	`zunion(K... keys)`	Execute the command ZUNION.
`long`	`zunionstore(K destination, ZAggregateArgs args, K... keys)`	Execute the command ZUNIONSTORE.
`long`	`zunionstore(K destination, K... keys)`	Execute the command ZUNIONSTORE.
`List<ScoredValue<V>>`	`zunionWithScores(ZAggregateArgs args, K... keys)`	Execute the command ZUNION.
`List<ScoredValue<V>>`	`zunionWithScores(K... keys)`	Execute the command ZUNION.

Methods inherited from interface io.quarkus.redis.datasource.RedisCommands
getDataSource

- Method Detail
  - zadd
```
boolean zadd(K key,
             double score,
             V member)
```
    Execute the command ZADD. Summary: Add one or more members to a sorted set, or update its score if it already exists Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    score - the score
    
    member - the member
    
    Returns:
    
    true if the element was added, false otherwise
  - zadd
```
int zadd(K key,
         Map<V,Double> items)
```
    Execute the command ZADD. Summary: Add one or more members to a sorted set, or update its score if it already exists Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    items - the map of score/value to be added
    
    Returns:
    
    the number of added elements
  - zadd
```
int zadd(K key,
         ScoredValue<V>... items)
```
    Execute the command ZADD. Summary: Add one or more members to a sorted set, or update its score if it already exists Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    items - the pairs of value/score to be added
    
    Returns:
    
    the number of added elements
  - zadd
```
boolean zadd(K key,
             ZAddArgs zAddArgs,
             double score,
             V member)
```
    Execute the command ZADD. Summary: Add one or more members to a sorted set, or update its score if it already exists Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    zAddArgs - the extra parameter
    
    score - the score
    
    member - the member
    
    Returns:
    
    true if the element was added or changed, false otherwise
  - zadd
```
int zadd(K key,
         ZAddArgs zAddArgs,
         Map<V,Double> items)
```
    Execute the command ZADD. Summary: Add one or more members to a sorted set, or update its score if it already exists Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    zAddArgs - the extra parameter
    
    items - the map of value/score to be added
    
    Returns:
    
    the number of added items
  - zadd
```
int zadd(K key,
         ZAddArgs zAddArgs,
         ScoredValue<V>... items)
```
    Execute the command ZADD. Summary: Add one or more members to a sorted set, or update its score if it already exists Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    zAddArgs - the extra parameter
    
    items - the pairs of score/value to be added
    
    Returns:
    
    the number of added items
  - zaddincr
```
double zaddincr(K key,
                double score,
                V member)
```
    Execute the command ZADD. Summary: Add one or more members to a sorted set, or update its score if it already exists applying the INCR option Group: sorted-set Requires Redis 1.2.0
    This variant of ZADD acts like ZINCRBY. Only one score-element pair can be specified in this mode.
    
    Parameters:
    
    key - the key.
    
    score - the increment.
    
    member - the member.
    
    Returns:
    
    the new score of the updated member
  - zaddincr
```
OptionalDouble zaddincr(K key,
                        ZAddArgs zAddArgs,
                        double score,
                        V member)
```
    Execute the command ZADD. Summary: Add one or more members to a sorted set, or update its score if it already exists applying the INCR option Group: sorted-set Requires Redis 1.2.0
    This variant of ZADD acts like ZINCRBY. Only one score-element pair can be specified in this mode.
    
    Parameters:
    
    key - the key.
    
    score - the increment.
    
    member - the member.
    
    Returns:
    
    the new score of the updated member, or empty if the operation was aborted (when called with either the XX or the NX option).
  - zcard
```
long zcard(K key)
```
    Execute the command ZCARD. Summary: Get the number of members in a sorted set Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the cardinality (number of elements) of the sorted set. 0 if the key does not exist.
  - zcount
```
long zcount(K key,
            ScoreRange<Double> range)
```
    Execute the command ZCOUNT. Summary: Count the members in a sorted set with scores within the given values Group: sorted-set Requires Redis 2.0.0
    
    Parameters:
    
    key - the key
    
    range - the range
    
    Returns:
    
    the number of elements in the specified score range.
  - zdiff
```
List<V> zdiff(K... keys)
```
    Execute the command ZDIFF. Summary: Subtract multiple sorted sets Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    keys - the keys
    
    Returns:
    
    the result of the difference.
  - zdiffWithScores
```
List<ScoredValue<V>> zdiffWithScores(K... keys)
```
    Execute the command ZDIFF. Summary: Subtract multiple sorted sets, and returns the list of keys with their scores Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    keys - the keys
    
    Returns:
    
    the result of the difference.
  - zdiffstore
```
long zdiffstore(K destination,
                K... keys)
```
    Execute the command ZDIFFSTORE. Summary: Subtract multiple sorted sets and store the resulting sorted set in a new key Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    destination - the destination key
    
    keys - the keys to compare
    
    Returns:
    
    the number of elements in the resulting sorted set at destination.
  - zincrby
```
double zincrby(K key,
               double increment,
               V member)
```
    Execute the command ZINCRBY. Summary: Increment the score of a member in a sorted set Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the new score of member
  - zinter
```
List<V> zinter(ZAggregateArgs arguments,
               K... keys)
```
    Execute the command ZINTER. Summary: Intersect multiple sorted sets Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    arguments - the ZINTER command extra-arguments
    
    keys - the keys
    
    Returns:
    
    the result of intersection.
  - zinter
```
List<V> zinter(K... keys)
```
    Execute the command ZINTER. Summary: Intersect multiple sorted sets Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    keys - the keys
    
    Returns:
    
    the result of intersection.
  - zinterWithScores
```
List<ScoredValue<V>> zinterWithScores(ZAggregateArgs arguments,
                                      K... keys)
```
    Execute the command ZINTER. Summary: Intersect multiple sorted sets Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    arguments - the ZINTER command extra-arguments
    
    keys - the keys
    
    Returns:
    
    the result of intersection with the scores
  - zinterWithScores
```
List<ScoredValue<V>> zinterWithScores(K... keys)
```
    Execute the command ZINTER. Summary: Intersect multiple sorted sets Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    keys - the keys
    
    Returns:
    
    the result of intersection with the scores
  - zintercard
```
long zintercard(K... keys)
```
    Execute the command ZINTERCARD. Summary: Intersect multiple sorted sets and return the cardinality of the result Group: sorted-set Requires Redis 7.0.0
    
    Parameters:
    
    keys - the keys
    
    Returns:
    
    the number of elements in the resulting intersection.
  - zintercard
```
long zintercard(long limit,
                K... keys)
```
    Execute the command ZINTERCARD. Summary: Intersect multiple sorted sets and return the cardinality of the result Group: sorted-set Requires Redis 7.0.0
    
    Parameters:
    
    limit - if the intersection cardinality reaches limit partway through the computation, the algorithm will exit and yield limit as the cardinality.
    
    keys - the keys
    
    Returns:
    
    the number of elements in the resulting intersection.
  - zinterstore
```
long zinterstore(K destination,
                 ZAggregateArgs arguments,
                 K... keys)
```
    Execute the command ZINTERSTORE. Summary: Intersect multiple sorted sets and store the resulting sorted set in a new key Group: sorted-set Requires Redis 2.0.0
    
    Parameters:
    
    destination - the destination key
    
    arguments - the ZINTERSTORE command extra-arguments
    
    keys - the keys of the sorted set to analyze
    
    Returns:
    
    the number of elements in the resulting sorted set at destination.
  - zinterstore
```
long zinterstore(K destination,
                 K... keys)
```
    Execute the command ZINTERSTORE. Summary: Intersect multiple sorted sets and store the resulting sorted set in a new key Group: sorted-set Requires Redis 2.0.0
    
    Parameters:
    
    destination - the destination key
    
    keys - the keys of the sorted set to analyze
    
    Returns:
    
    the number of elements in the resulting sorted set at destination.
  - zlexcount
```
long zlexcount(K key,
               Range<String> range)
```
    Execute the command ZLEXCOUNT. Summary: Count the number of members in a sorted set between a given lexicographical range Group: sorted-set Requires Redis 2.8.9
    
    Parameters:
    
    key - the key
    
    range - the range
    
    Returns:
    
    the number of elements in the specified score range.
  - zmpopMin
```
ScoredValue<V> zmpopMin(K... keys)
```
    Execute the command ZMPOP. Summary: Remove and return members with scores in a sorted set Group: sorted-set Requires Redis 7.0.0
    The elements popped are those with the lowest scores from the first non-empty sorted set.
    
    Parameters:
    
    keys - the keys
    
    Returns:
    
    The popped element (value / score), or null if no element can be popped.
  - zmpopMin
```
List<ScoredValue<V>> zmpopMin(int count,
                              K... keys)
```
    Execute the command ZMPOP. Summary: Remove and return members with scores in a sorted set Group: sorted-set Requires Redis 7.0.0
    The elements popped are those with the lowest scores from the first non-empty sorted set.
    
    Parameters:
    
    count - the max number of element to pop
    
    keys - the keys
    
    Returns:
    
    The popped element (value / score), or empty if no element can be popped.
  - zmpopMax
```
ScoredValue<V> zmpopMax(K... keys)
```
    Execute the command ZMPOP. Summary: Remove and return members with scores in a sorted set Group: sorted-set Requires Redis 7.0.0
    The elements with the highest scores to be popped.
    
    Parameters:
    
    keys - the keys
    
    Returns:
    
    The popped element (value / score), or null if no element can be popped.
  - zmpopMax
```
List<ScoredValue<V>> zmpopMax(int count,
                              K... keys)
```
    Execute the command ZMPOP. Summary: Remove and return members with scores in a sorted set Group: sorted-set Requires Redis 7.0.0
    The elements with the highest scores to be popped.
    
    Parameters:
    
    count - the max number of element to pop
    
    keys - the keys
    
    Returns:
    
    The popped element (value / score), or empty if no element can be popped.
  - bzmpopMin
```
ScoredValue<V> bzmpopMin(Duration timeout,
                         K... keys)
```
    Execute the command BZMPOP. Summary: Remove and return members with scores in a sorted set or block until one is available. Group: sorted-set Requires Redis 7.0.0
    The elements popped are those with the lowest scores from the first non-empty sorted set.
    
    Parameters:
    
    timeout - the timeout
    
    keys - the keys
    
    Returns:
    
    The popped element (value / score), or null if no element can be popped.
  - bzmpopMin
```
List<ScoredValue<V>> bzmpopMin(Duration timeout,
                               int count,
                               K... keys)
```
    Execute the command BZMPOP. Summary: Remove and return members with scores in a sorted set or block until one is available. Group: sorted-set Requires Redis 7.0.0
    The elements popped are those with the lowest scores from the first non-empty sorted set.
    
    Parameters:
    
    timeout - the timeout
    
    count - the max number of element to pop
    
    keys - the keys
    
    Returns:
    
    The popped element (value / score), or empty if no element can be popped.
  - bzmpopMax
```
ScoredValue<V> bzmpopMax(Duration timeout,
                         K... keys)
```
    Execute the command BZMPOP. Summary: Remove and return members with scores in a sorted set or block until one is available. Group: sorted-set Requires Redis 7.0.0
    The elements with the highest scores to be popped.
    
    Parameters:
    
    timeout - the timeout
    
    keys - the keys
    
    Returns:
    
    The popped element (value / score), or null if no element can be popped.
  - bzmpopMax
```
List<ScoredValue<V>> bzmpopMax(Duration timeout,
                               int count,
                               K... keys)
```
    Execute the command BZMPOP. Summary: Remove and return members with scores in a sorted set or block until one is available. Group: sorted-set Requires Redis 7.0.0
    The elements with the highest scores to be popped.
    
    Parameters:
    
    timeout - the timeout
    
    count - the max number of element to pop
    
    keys - the keys
    
    Returns:
    
    The popped element (value / score), or empty if no element can be popped.
  - zmscore
```
List<OptionalDouble> zmscore(K key,
                             V... members)
```
    Execute the command ZMSCORE. Summary: Get the score associated with the given members in a sorted set Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    key - the key
    
    members - the members
    
    Returns:
    
    list of scores or empty associated with the specified member values.
  - zpopmax
```
ScoredValue<V> zpopmax(K key)
```
    Execute the command ZPOPMAX. Summary: Remove and return members with the highest scores in a sorted set Group: sorted-set Requires Redis 5.0.0
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the popped element and score, ScoredValue.EMPTY is no member can be popped.
  - zpopmax
```
List<ScoredValue<V>> zpopmax(K key,
                             int count)
```
    Execute the command ZPOPMAX. Summary: Remove and return members with the highest scores in a sorted set Group: sorted-set Requires Redis 5.0.0
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the popped elements and scores.
  - zpopmin
```
ScoredValue<V> zpopmin(K key)
```
    Execute the command ZPOPMIN. Summary: Remove and return members with the lowest scores in a sorted set Group: sorted-set Requires Redis 5.0.0
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the popped element and score, ScoredValue.EMPTY is no member can be popped.
  - zpopmin
```
List<ScoredValue<V>> zpopmin(K key,
                             int count)
```
    Execute the command ZPOPMIN. Summary: Remove and return members with the lowest scores in a sorted set Group: sorted-set Requires Redis 5.0.0
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the popped elements and scores.
  - zrandmember
```
V zrandmember(K key)
```
    Execute the command ZRANDMEMBER. Summary: Get one or multiple random elements from a sorted set Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the randomly selected element, or null when key does not exist.
  - zrandmember
```
List<V> zrandmember(K key,
                    int count)
```
    Execute the command ZRANDMEMBER. Summary: Get one or multiple random elements from a sorted set Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    key - the key
    
    count - the number of member to select
    
    Returns:
    
    the list of elements, or an empty array when key does not exist.
  - zrandmemberWithScores
```
ScoredValue<V> zrandmemberWithScores(K key)
```
    Execute the command ZRANDMEMBER. Summary: Get one or multiple random elements from a sorted set Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the randomly selected element and its score, or null when key does not exist.
  - zrandmemberWithScores
```
List<ScoredValue<V>> zrandmemberWithScores(K key,
                                           int count)
```
    Execute the command ZRANDMEMBER. Summary: Get one or multiple random elements from a sorted set Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    key - the key
    
    count - the number of member to select
    
    Returns:
    
    the list of elements (with their score), or an empty array when key does not exist.
  - bzpopmin
```
KeyValue<K,ScoredValue<V>> bzpopmin(Duration timeout,
                                          K... keys)
```
    Execute the command BZPOPMIN. Summary: Remove and return the member with the lowest score from one or more sorted sets, or block until one is available Group: sorted-set Requires Redis 5.0.0
    
    Parameters:
    
    timeout - the max timeout
    
    keys - the keys
    
    Returns:
    
    null when no element could be popped and the timeout expired. A structure containing the key and the ScoredValue with the popped value and the score.
  - bzpopmax
```
KeyValue<K,ScoredValue<V>> bzpopmax(Duration timeout,
                                          K... keys)
```
    Execute the command BZPOPMAX. Summary: Remove and return the member with the highest score from one or more sorted sets, or block until one is available Group: sorted-set Requires Redis 5.0.0
    
    Returns:
    
    null when no element could be popped and the timeout expired. A structure containing the key and the ScoredValue with the popped value and the score.
  - zrange
```
List<V> zrange(K key,
               long start,
               long stop,
               ZRangeArgs args)
```
    Execute the command ZRANGE. Summary: Return a range of members in a sorted set Group: sorted-set Requires Redis 1.2.0
    This method extracts a range my rank/index in the stream.
    
    Parameters:
    
    key - the key
    
    start - the start position
    
    stop - the stop position
    
    args - the extra ZRANGE parameters
    
    Returns:
    
    list of elements in the specified range.
  - zrangeWithScores
```
List<ScoredValue<V>> zrangeWithScores(K key,
                                      long start,
                                      long stop,
                                      ZRangeArgs args)
```
    Execute the command ZRANGE. Summary: Return a range of members in a sorted set Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    start - the start position
    
    stop - the stop position
    
    args - the extra ZRANGE parameters
    
    Returns:
    
    list of elements with their scores in the specified range.
  - zrange
```
List<V> zrange(K key,
               long start,
               long stop)
```
    Execute the command ZRANGE. Summary: Return a range of members in a sorted set Group: sorted-set Requires Redis 1.2.0
    This method extracts a range my rank/index in the stream.
    
    Parameters:
    
    key - the key
    
    start - the start position
    
    stop - the stop position
    
    Returns:
    
    list of elements in the specified range.
  - zrangeWithScores
```
List<ScoredValue<V>> zrangeWithScores(K key,
                                      long start,
                                      long stop)
```
    Execute the command ZRANGE. Summary: Return a range of members in a sorted set Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    start - the start position
    
    stop - the stop position
    
    Returns:
    
    list of elements with their scores in the specified range.
  - zrangebylex
```
List<V> zrangebylex(K key,
                    Range<String> range,
                    ZRangeArgs args)
```
    Execute the command ZRANGE. Summary: Return a range of members in a sorted set using lexicographical ranges Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    range - the range
    
    args - the extra ZRANGE parameters
    
    Returns:
    
    list of elements in the specified range.
  - zrangebylex
```
List<V> zrangebylex(K key,
                    Range<String> range)
```
    Execute the command ZRANGE. Summary: Return a range of members in a sorted set using lexicographical ranges Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    range - the range
    
    Returns:
    
    list of elements in the specified range.
  - zrangebyscore
```
List<V> zrangebyscore(K key,
                      ScoreRange<Double> range,
                      ZRangeArgs args)
```
    Execute the command ZRANGE. Summary: Return a range of members in a sorted set using score ranges Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    range - the range
    
    args - the extra ZRANGE parameters
    
    Returns:
    
    list of elements in the specified range.
  - zrangebyscoreWithScores
```
List<ScoredValue<V>> zrangebyscoreWithScores(K key,
                                             ScoreRange<Double> range,
                                             ZRangeArgs args)
```
    Execute the command ZRANGE. Summary: Return a range of members in a sorted set using lexicographical ranges Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    range - the range
    
    args - the extra ZRANGE parameters
    
    Returns:
    
    list of elements with their scores in the specified range.
  - zrangebyscore
```
List<V> zrangebyscore(K key,
                      ScoreRange<Double> range)
```
    Execute the command ZRANGE. Summary: Return a range of members in a sorted set using score ranges Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    range - the range
    
    Returns:
    
    list of elements in the specified range.
  - zrangebyscoreWithScores
```
List<ScoredValue<V>> zrangebyscoreWithScores(K key,
                                             ScoreRange<Double> range)
```
    Execute the command ZRANGE. Summary: Return a range of members in a sorted set using score ranges Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    range - the range
    
    Returns:
    
    list of elements with their scores in the specified range.
  - zrangestore
```
long zrangestore(K dst,
                 K src,
                 long min,
                 long max,
                 ZRangeArgs args)
```
    Execute the command ZRANGESTORE. Summary: Store a range (by rank) of members from sorted set into another key Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    dst - the key
    
    src - the key
    
    min - the lower bound of the range
    
    max - the upper bound of the range
    
    args - the ZRANGESTORE command extra-arguments
    
    Returns:
    
    the number of elements in the resulting sorted set.
  - zrangestore
```
long zrangestore(K dst,
                 K src,
                 long min,
                 long max)
```
    Execute the command ZRANGESTORE. Summary: Store a range (by rank) of members from sorted set into another key Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    dst - the key
    
    src - the key
    
    min - the lower bound of the range
    
    max - the upper bound of the range
    
    Returns:
    
    the number of elements in the resulting sorted set.
  - zrangestorebylex
```
long zrangestorebylex(K dst,
                      K src,
                      Range<String> range,
                      ZRangeArgs args)
```
    Execute the command ZRANGESTORE. Summary: Store a range (by lexicographical order) of members from sorted set into another key Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    dst - the key
    
    src - the key
    
    range - the range
    
    args - the ZRANGESTORE command extra-arguments
    
    Returns:
    
    the number of elements in the resulting sorted set.
  - zrangestorebylex
```
long zrangestorebylex(K dst,
                      K src,
                      Range<String> range)
```
    Execute the command ZRANGESTORE. Summary: Store a range (by lexicographical order) of members from sorted set into another key Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    dst - the key
    
    src - the key
    
    range - the range
    
    Returns:
    
    the number of elements in the resulting sorted set.
  - zrangestorebyscore
```
long zrangestorebyscore(K dst,
                        K src,
                        ScoreRange<Double> range,
                        ZRangeArgs args)
```
    Execute the command ZRANGESTORE. Summary: Store a range (by score order) of members from sorted set into another key Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    dst - the key
    
    src - the key
    
    range - the range
    
    args - the ZRANGESTORE command extra-arguments
    
    Returns:
    
    the number of elements in the resulting sorted set.
  - zrangestorebyscore
```
long zrangestorebyscore(K dst,
                        K src,
                        ScoreRange<Double> range)
```
    Execute the command ZRANGESTORE. Summary: Store a range (by score order) of members from sorted set into another key Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    dst - the key
    
    src - the key
    
    range - the range
    
    Returns:
    
    the number of elements in the resulting sorted set.
  - zrank
```
OptionalLong zrank(K key,
                   V member)
```
    Execute the command ZRANK. Summary: Determine the index of a member in a sorted set Group: sorted-set Requires Redis 2.0.0
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the rank of member. If member does not exist in the sorted set or key does not exist, empty.
  - zrem
```
int zrem(K key,
         V... members)
```
    Execute the command ZREM. Summary: Remove one or more members from a sorted set Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    members - the members to remove
    
    Returns:
    
    The number of members removed from the sorted set, not including non-existing members.
  - zremrangebylex
```
long zremrangebylex(K key,
                    Range<String> range)
```
    Execute the command ZREMRANGEBYLEX. Summary: Remove all members in a sorted set between the given lexicographical range Group: sorted-set Requires Redis 2.8.9
    
    Parameters:
    
    key - the key
    
    range - the range
    
    Returns:
    
    the number of elements removed.
  - zremrangebyrank
```
long zremrangebyrank(K key,
                     long start,
                     long stop)
```
    Execute the command ZREMRANGEBYRANK. Summary: Remove all members in a sorted set within the given indexes Group: sorted-set Requires Redis 2.0.0
    
    Parameters:
    
    key - the key
    
    start - the lower bound of the range
    
    stop - the upper bound of the range
    
    Returns:
    
    the number of elements removed.
  - zremrangebyscore
```
long zremrangebyscore(K key,
                      ScoreRange<Double> range)
```
    Execute the command ZREMRANGEBYSCORE. Summary: Remove all members in a sorted set within the given scores Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    range - the range
    
    Returns:
    
    the number of elements removed.
  - zrevrank
```
OptionalLong zrevrank(K key,
                      V member)
```
    Execute the command ZREVRANK. Summary: Determine the index of a member in a sorted set, with scores ordered from high to low Group: sorted-set Requires Redis 2.0.0
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the rank of member. If member does not exist in the sorted set or key does not exist, empty.
  - zscan
```
ZScanCursor<V> zscan(K key)
```
    Execute the command ZSCAN. Summary: Incrementally iterate sorted sets elements and associated scores Group: sorted-set Requires Redis 2.8.0
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the cursor to iterate over the sorted set
  - zscan
```
ZScanCursor<V> zscan(K key,
                     ScanArgs args)
```
    Execute the command ZSCAN. Summary: Incrementally iterate sorted sets elements and associated scores Group: sorted-set Requires Redis 2.8.0
    
    Parameters:
    
    key - the key
    
    args - the extra scan arguments
    
    Returns:
    
    the cursor to iterate over the sorted set
  - zscore
```
OptionalDouble zscore(K key,
                      V member)
```
    Execute the command ZSCORE. Summary: Get the score associated with the given member in a sorted set Group: sorted-set Requires Redis 1.2.0
    
    Parameters:
    
    key - the key
    
    member - the member
    
    Returns:
    
    the score of member, empty if the member cannot be found or the key does not exist
  - zunion
```
List<V> zunion(ZAggregateArgs args,
               K... keys)
```
    Execute the command ZUNION. Summary: Add multiple sorted sets Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    args - the ZUNION command extra-arguments
    
    keys - the keys
    
    Returns:
    
    the result of union
  - zunion
```
List<V> zunion(K... keys)
```
    Execute the command ZUNION. Summary: Add multiple sorted sets Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    keys - the keys
    
    Returns:
    
    the result of union
  - zunionWithScores
```
List<ScoredValue<V>> zunionWithScores(ZAggregateArgs args,
                                      K... keys)
```
    Execute the command ZUNION. Summary: Add multiple sorted sets Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    args - the ZUNION command extra-arguments
    
    keys - the keys
    
    Returns:
    
    the result of union
  - zunionWithScores
```
List<ScoredValue<V>> zunionWithScores(K... keys)
```
    Execute the command ZUNION. Summary: Add multiple sorted sets Group: sorted-set Requires Redis 6.2.0
    
    Parameters:
    
    keys - the keys
    
    Returns:
    
    the result of union
  - zunionstore
```
long zunionstore(K destination,
                 ZAggregateArgs args,
                 K... keys)
```
    Execute the command ZUNIONSTORE. Summary: Add multiple sorted sets and store the resulting sorted set in a new key Group: sorted-set Requires Redis 2.0.0
    
    Parameters:
    
    destination - the destination key
    
    args - the zunionstore command extra-arguments
    
    keys - the keys
    
    Returns:
    
    the number of elements in the resulting sorted set at destination.
  - zunionstore
```
long zunionstore(K destination,
                 K... keys)
```
    Execute the command ZUNIONSTORE. Summary: Add multiple sorted sets and store the resulting sorted set in a new key Group: sorted-set Requires Redis 2.0.0
    
    Parameters:
    
    destination - the destination key
    
    keys - the keys
    
    Returns:
    
    the number of elements in the resulting sorted set at destination.
  - sort
```
List<V> sort(K key)
```
    Execute the command SORT. Summary: Sort the elements in a list, set or sorted set Group: generic Requires Redis 1.0.0
    
    Returns:
    
    the list of sorted elements.
  - sort
```
List<V> sort(K key,
             SortArgs sortArguments)
```
    Execute the command SORT. Summary: Sort the elements in a list, set or sorted set Group: generic Requires Redis 1.0.0
    
    Parameters:
    
    key - the key
    
    sortArguments - the SORT command extra-arguments
    
    Returns:
    
    the list of sorted elements.
  - sortAndStore
```
long sortAndStore(K key,
                  K destination,
                  SortArgs sortArguments)
```
    Execute the command SORT with the STORE option. Summary: Sort the elements in a list, set or sorted set Group: generic Requires Redis 1.0.0
    
    Parameters:
    
    sortArguments - the SORT command extra-arguments
    
    Returns:
    
    the number of sorted elements in the destination list.
  - sortAndStore
```
long sortAndStore(K key,
                  K destination)
```
    Execute the command SORT with the STORE option. Summary: Sort the elements in a list, set or sorted set Group: generic Requires Redis 1.0.0
    
    Returns:
    
    the number of sorted elements in the destination list.

Interface SortedSetCommands<K,​V>

Method Summary

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

Method Detail

zadd

zadd

zadd

zadd

zadd

zadd

zaddincr

zaddincr

zcard

zcount

zdiff

zdiffWithScores

zdiffstore

zincrby

zinter

zinter

zinterWithScores

zinterWithScores

zintercard

zintercard

zinterstore

zinterstore

zlexcount

zmpopMin

zmpopMin

zmpopMax

zmpopMax

bzmpopMin

bzmpopMin

bzmpopMax

bzmpopMax

zmscore

zpopmax

zpopmax

zpopmin

zpopmin

zrandmember

zrandmember

zrandmemberWithScores

zrandmemberWithScores

bzpopmin

bzpopmax

zrange

zrangeWithScores

zrange

zrangeWithScores

zrangebylex

zrangebylex

zrangebyscore

zrangebyscoreWithScores

zrangebyscore

zrangebyscoreWithScores

zrangestore

zrangestore

zrangestorebylex

zrangestorebylex

zrangestorebyscore

zrangestorebyscore

zrank

zrem

zremrangebylex

zremrangebyrank

zremrangebyscore

zrevrank

zscan

zscan

zscore

zunion

zunion

zunionWithScores

zunionWithScores

zunionstore

zunionstore

sort

sort

sortAndStore

Interface SortedSetCommands<K,V>