zpopmax.3valkey - Man Page
Returns the highest-scoring members from a sorted set after removing them. Deletes the sorted set if the last member was popped.
Synopsis
ZPOPMAX
key [count]
Description
Removes and returns up to count
members with the highest scores in the sorted set stored at key
.
When left unspecified, the default value for count
is 1. Specifying a count
value that is higher than the sorted set’s cardinality will not produce an error. When returning multiple elements, the one with the highest score will be the first, followed by the elements with lower scores.
Reply
- valkey-protocol(7) Array reply: a list of popped elements and scores.
Complexity
O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped.
Acl Categories
@fast @sortedset @write
History
- Available since: 5.0.0
Examples
127.0.0.1:6379> ZADD myzset 1 "one" (integer) 1 127.0.0.1:6379> ZADD myzset 2 "two" (integer) 1 127.0.0.1:6379> ZADD myzset 3 "three" (integer) 1 127.0.0.1:6379> ZPOPMAX myzset 1) "three" 2) "3"
See Also
bzmpop(3valkey), bzpopmax(3valkey), bzpopmin(3valkey), zadd(3valkey), zcard(3valkey), zcount(3valkey), zdiff(3valkey), zdiffstore(3valkey), zincrby(3valkey), zinter(3valkey), zintercard(3valkey), zinterstore(3valkey), zlexcount(3valkey), zmpop(3valkey), zmscore(3valkey), zpopmin(3valkey), zrandmember(3valkey), zrange(3valkey), zrangestore(3valkey), zrank(3valkey), zrem(3valkey), zremrangebylex(3valkey), zremrangebyrank(3valkey), zremrangebyscore(3valkey), zrevrank(3valkey), zscan(3valkey), zscore(3valkey), zunion(3valkey), zunionstore(3valkey)