Download documentation

Choose the products and versions you want. Everything arrives as one .tar.gz, with a directory per product.

Format

This page

	Products	Version
	Develop with Redis Clients, data types, programmability, and Redis for AI. RedisVL is listed separately.
	Libraries and tools Client libraries, observability, and cloud integrations. Redis Data Integration is listed separately.
	RedisVL
	Redis Software
	Redis Cloud
	Redis for Kubernetes
	Redis Open Source
	Redis Iris context engine
	Redis Feature Form
	Redis Insight
	Redis Data Integration
	Glossary
	Command reference

BZMPOP

Syntax text Syntax diagram API methods

BZMPOP timeout numkeys key [key ...] <MIN | MAX> [COUNT count]

Client:

bzmpop(
    timeout: float,
    numkeys: int,
    keys: List[str],
    min: Optional[bool] = False,
    max: Optional[bool] = False,
    count: Optional[int] = 1
) → Optional[list]

BZMPOP(
    timeout: number,
    ...args: ZMPopArguments
) → Any

bzmpop(
    timeout: double,
    option: SortedSetOption,
    keys: String...
) → KeyValue<String, List<Tuple>>

bzmpop(
    timeout: double,
    option: SortedSetOption,
    count: int,
    keys: String...
) → KeyValue<String, List<Tuple>>

bzmpop(
    timeout: long,  // the timeout in seconds.
    args: ZPopArgs,  // the command args.
    keys: K...  // the keys.
) → KeyValue<K, ScoredValue<V>>  // ScoredValue&lt;V&gt; the removed elements or KeyValue#empty(). @since 6.3

bzmpop(
    timeout: long,  // the timeout in seconds.
    count: long,  // number of elements to pop.
    args: ZPopArgs,  // the command args.
    keys: K...  // the keys.
) → KeyValue<K, List<ScoredValue<V>>>  // ScoredValue&lt;V&gt; the removed elements or KeyValue#empty(). @since 6.3

bzmpop(
    timeout: double,  // the timeout in seconds.
    args: ZPopArgs,  // the command args.
    keys: K...  // the keys.
) → KeyValue<K, ScoredValue<V>>  // ScoredValue&lt;V&gt; the removed elements or KeyValue#empty(). @since 6.3

bzmpop(
    timeout: double,  // the timeout in seconds.
    count: int,  // number of elements to pop.
    args: ZPopArgs,  // the command args.
    keys: K...  // the keys.
) → KeyValue<K, List<ScoredValue<V>>>  // ScoredValue&lt;V&gt; the removed elements or KeyValue#empty(). @since 6.3

bzmpop(
    timeout: long,  // the timeout in seconds.
    args: ZPopArgs,  // the command args.
    keys: K...  // the keys.
) → RedisFuture<KeyValue<K, ScoredValue<V>>>  // ScoredValue&lt;V&gt; the removed elements or KeyValue#empty(). @since 6.3

bzmpop(
    timeout: long,  // the timeout in seconds.
    count: long,  // number of elements to pop.
    args: ZPopArgs,  // the command args.
    keys: K...  // the keys.
) → RedisFuture<KeyValue<K, List<ScoredValue<V>>>>  // ScoredValue&lt;V&gt; the removed elements or KeyValue#empty(). @since 6.3

bzmpop(
    timeout: double,  // the timeout in seconds.
    args: ZPopArgs,  // the command args.
    keys: K...  // the keys.
) → RedisFuture<KeyValue<K, ScoredValue<V>>>  // ScoredValue&lt;V&gt; the removed elements or KeyValue#empty(). @since 6.3

bzmpop(
    timeout: double,  // the timeout in seconds.
    count: int,  // number of elements to pop.
    args: ZPopArgs,  // the command args.
    keys: K...  // the keys.
) → RedisFuture<KeyValue<K, List<ScoredValue<V>>>>  // ScoredValue&lt;V&gt; the removed elements or KeyValue#empty(). @since 6.3

bzmpop(
    timeout: long,  // the timeout in seconds.
    args: ZPopArgs,  // the command args.
    keys: K...  // the keys.
) → Mono<KeyValue<K, ScoredValue<V>>>  // ScoredValue&lt;V&gt; the removed elements or KeyValue#empty(). @since 6.3

bzmpop(
    timeout: long,  // the timeout in seconds.
    count: long,  // number of elements to pop.
    args: ZPopArgs,  // the command args.
    keys: K...  // the keys.
) → Mono<KeyValue<K, List<ScoredValue<V>>>>  // ScoredValue&lt;V&gt; the removed elements or KeyValue#empty(). @since 6.3

bzmpop(
    timeout: double,  // the timeout in seconds.
    args: ZPopArgs,  // the command args.
    keys: K...  // the keys.
) → Mono<KeyValue<K, ScoredValue<V>>>  // ScoredValue&lt;V&gt; the removed elements or KeyValue#empty(). @since 6.3

bzmpop(
    timeout: double,  // the timeout in seconds.
    count: int,  // number of elements to pop.
    args: ZPopArgs,  // the command args.
    keys: K...  // the keys.
) → Mono<KeyValue<K, List<ScoredValue<V>>>>  // ScoredValue&lt;V&gt; the removed elements or KeyValue#empty(). @since 6.3

BZMPop(
    ctx: context.Context,
    timeout: time.Duration,
    order: string,
    count: int64,
    keys: ...string
) → *ZSliceWithKeyCmd

BZMPop(
    timeout: double,
    keys: RedisKey[],
    minMaxModifier: MinMaxModifier,
    count: long?
) → Tuple<RedisKey, List<RedisValueWithScore>>?

BZMPop(
    timeout: double,
    key: RedisKey,
    minMaxModifier: MinMaxModifier,
    count: long?
) → Tuple<RedisKey, List<RedisValueWithScore>>?

BZMPop(
    db: Any,
    timeout: Any,
    [key]: Any,
    minMaxModifier: Any,
    count: Any
) → return

bzmpop(
    $timeout: int,
    $keys: array,
    string $modifier = 'min': Any,
    int $count = 1: Any
) → array

bzmpop_max(
    timeout: f64,
    keys: K,
    count: isize
) → (Option<(String, Vec<(String, f64)>)>)

bzmpop_min(
    timeout: f64,
    keys: K,
    count: isize
) → (Option<(String, Vec<(String, f64)>)>)

bzmpop_max(
    timeout: f64,
    keys: K,
    count: isize
) → (Option<(String, Vec<(String, f64)>)>)

bzmpop_min(
    timeout: f64,
    keys: K,
    count: isize
) → (Option<(String, Vec<(String, f64)>)>)

Available since:: Redis Open Source 7.0.0
Time complexity:: O(K) + O(M*log(N)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped.
ACL categories:: @write, @sortedset, @slow, @blocking,
Compatibility:: Redis Software and Redis Cloud compatibility

Note:

This command's behavior varies in clustered Redis environments. See the multi-key operations page for more information.

BZMPOP is the blocking variant of ZMPOP.

When any of the sorted sets contains elements, this command behaves exactly like ZMPOP. When used inside a MULTI/EXEC block or a Lua script, this command behaves exactly like ZMPOP. When all sorted sets are empty, Redis will block the connection until another client adds members to one of the keys or until the timeout (a double value specifying the maximum number of seconds to block) elapses. A timeout of zero can be used to block indefinitely.

See ZMPOP for more information.

Required arguments

timeout

The maximum time to block, in seconds. A timeout of 0 blocks indefinitely.

numkeys

The number of keys that follow.

key [key ...]

One or more sorted-set keys to pop from.

MIN | MAX

Pop the members with the lowest scores (MIN) or the highest scores (MAX).

Optional arguments

COUNT count

The number of members to pop. Defaults to 1.

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

One of the following:

Nil reply: when no element could be popped.
Array reply: a two-element array with the first element being the name of the key from which elements were popped, and the second element is an array of the popped elements. Every entry in the elements array is also an array that contains the member and its score.

One of the following:

Null reply: when no element could be popped.
Array reply: a two-element array with the first element being the name of the key from which elements were popped, and the second element is an array of the popped elements. Every entry in the elements array is also an array that contains the member and its score.