BZPOPMIN

Syntax
BZPOPMIN key [key ...] timeout
Available since:
5.0.0
Time complexity:
O(log(N)) with N being the number of elements in the sorted set.
ACL categories:
@write, @sortedset, @fast, @blocking,

BZPOPMIN is the blocking variant of the sorted set ZPOPMIN primitive.

It is the blocking version because it blocks the connection when there are no members to pop from any of the given sorted sets. A member with the lowest score is popped from first sorted set that is non-empty, with the given keys being checked in the order that they are given.

The timeout argument is interpreted as a double value specifying the maximum number of seconds to block. A timeout of zero can be used to block indefinitely.

See the BLPOP documentation for the exact semantics, since BZPOPMIN is identical to BLPOP with the only difference being the data structure being popped from.

Examples

redis> DEL zset1 zset2
(integer) 0
redis> ZADD zset1 0 a 1 b 2 c
(integer) 3
redis> BZPOPMIN zset1 zset2 0
1) "zset1"
2) "a"
3) "0"

RESP2 Reply

One of the following:

  • Nil reply: when no element could be popped and the timeout expired.
  • Array reply: the keyname, popped member, and its score.

RESP3 Reply

One of the following:

  • Null reply: when no element could be popped and the timeout expired.
  • Array reply: the keyname, popped member, and its score.

History

  • Starting with Redis version 6.0.0: timeout is interpreted as a double instead of an integer.
RATE THIS PAGE
Back to top ↑