bzpopmin.3valkey - Man Page
Removes and returns the member with the lowest score from one or more sorted sets. Blocks until a member is available otherwise. Deletes the sorted set if the last element was popped.
Synopsis
BZPOPMIN
key [key...] timeout
Description
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.
Reply
Resp2
One of the following:
- valkey-protocol(7) Nil reply: when no element could be popped and the timeout expired.
- valkey-protocol(7) Array reply: the keyname, popped member, and its score.
Resp3
One of the following:
- valkey-protocol(7) Null reply: when no element could be popped and the timeout expired.
- valkey-protocol(7) Array reply: the keyname, popped member, and its score.
Complexity
O(log(N)) with N being the number of elements in the sorted set.
Acl Categories
@blocking @fast @sortedset @write
History
- Available since: 5.0.0
- Changed in 6.0.0:
timeout
is interpreted as a double instead of an integer.
Examples
127.0.0.1:6379> DEL zset1 zset2 (integer) 0 127.0.0.1:6379> ZADD zset1 0 a 1 b 2 c (integer) 3 127.0.0.1:6379> BZPOPMIN zset1 zset2 0 1) "zset1" 2) "a" 3) "0"
See Also
bzmpop(3valkey), bzpopmax(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), zpopmax(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)