Skip to main content

ZPOPMAX

Introduction​

In Dragonfly, as well as in Redis and Valkey, the ZPOPMAX command is used to remove and return the members with the highest scores in a sorted set. This command is particularly useful when you need to implement a priority queue or retrieve the most important elements based on real-time scores.

Syntax​

ZPOPMAX key [count]
  • Time 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: @write, @sortedset, @fast

Parameter Explanations​

  • key: The key of the sorted set to pop the maximum scored elements.
  • count (optional): The number of elements to pop. If not specified, it defaults to 1.

Return Values​

  • If count is not provided, the command returns a two-element array: the member with the highest score and its corresponding score.
  • If count is provided, the command returns an array of arrays, where each array consists of a member and its score, up to the specified count.
  • If the sorted set is empty or doesn't exist, the command returns nil.

Code Examples​

Basic Example​

Remove and return the member with the highest score from a sorted set:

dragonfly> ZADD myzset 1 "one" 2 "two" 3 "three"
(integer) 3
dragonfly> ZPOPMAX myzset
1) "three"
2) "3"

Popping Multiple Maximum Elements​

Remove and return the top 2 members with the highest scores:

dragonfly> ZADD myzset 1 "one" 2 "two" 3 "three" 4 "four"
(integer) 4
dragonfly> ZPOPMAX myzset 2
1) "four"
2) "4"
3) "three"
4) "3"

Handling an Empty or Non-Existent Sorted Set​

If the sorted set doesn't exist, ZPOPMAX will return nil.

dragonfly> ZPOPMAX emptyset
(nil)

Best Practices​

  • Use ZPOPMAX when implementing stacks, priority queues, or leaderboard systems where you need to process or remove the highest priority items first.
  • Be cautious when popping multiple elements (count parameter), as popping large amounts at once can lead to performance bottlenecks; consider batching wisely.

Common Mistakes​

  • Using the command on a non-sorted set data structure will result in an error.
  • Not considering the impact of popping multiple elements when performance is a concern. If your goal is to improve throughput, process smaller batches.

FAQs​

What happens if the sorted set has fewer elements than count?​

If the sorted set has fewer elements than the provided count, ZPOPMAX will return all the available elements and remove them from the set.

Can I use negative values for the count parameter?​

No, count must always be a non-negative integer. A negative value will result in an error.

Does ZPOPMAX modify the sorted set?​

Yes, ZPOPMAX removes the returned members from the set.