ZPOPMAX to remove and return the members with the highest scores in a sorted set.
Without a count one member is returned with its score, and with a count up to that many are removed, ordered from the highest score down. A missing or empty key returns an empty result, and the key is deleted once the last member is popped.
Since the read and the removal are atomic, no two workers can take the same member, which turns a sorted set into a priority queue where the score is the priority. BZPOPMAX is the blocking form.
Syntax
Arguments
Important points
- RESP2 represents floating-point reply values as bulk strings; RESP3 may use native double replies. Client libraries commonly decode either form to a language number.
Response
The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.
Examples
TCP examples use the TLSREDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.
Redis CLI
Redis CLI
@upstash/redis
@upstash/redis
upstash_redis
upstash_redis
ioredis
ioredis
node-redis
node-redis
redis-py
redis-py
go-redis
go-redis
jedis
jedis
redis-rs
redis-rs