Redis Iris

Redis install Data types

Tools Community Docs

Login Sign up

Develop with Redis Libraries and tools Redis products

Commands

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

BZPOPMAX

Syntax text Syntax diagram API methods

BZPOPMAX key [key ...] timeout

Client:

bzpopmax(
    keys: KeysT,
    timeout: TimeoutSecT = 0
) → ResponseT

Possible errors

ERR value is not an integer: ResponseError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

bzPopMax(
    keys: RedisVariadicArgument,
    timeout: number
) → Any

Possible errors

ERR value is not an integer: SimpleError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

bzpopmax(
    ...keys: RedisKey[],
    timeout: number | string,
    callback: Callback<[key: string, member: string, score: string] | null>
) → Result<[key: string, member: string, score: string] | null, Context>

bzpopmax(
    keys: RedisKey[],
    timeout: number | string,
    callback: Callback<[key: string, member: string, score: string] | null>
) → Result<[key: string, member: string, score: string] | null, Context>

bzpopmax(
    ...keys: RedisKey[],
    timeout: number | string
) → Result<[key: string, member: string, score: string] | null, Context>

bzpopmax(
    keys: RedisKey[],
    timeout: number | string
) → Result<[key: string, member: string, score: string] | null, Context>

Possible errors

ERR value is not an integer: ReplyError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

bzpopmax(
    timeout: double,
    keys: String...
) → KeyValue<String, Tuple>  // BLPOP returns a two-elements array via a multi bulk reply in order to return both the unblocking key and the popped value. When a non-zero timeout is specified, and the BLPOP operation timed out, the return value is a nil multi bulk reply. Most connection values will return false or nil accordingly to the programming language used.

Possible errors

ERR value is not an integer: JedisDataException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

bzpopmax(
    timeout: long,  // the timeout in seconds.
    keys: K...  // the keys.
) → KeyValue<K, ScoredValue<V>>  // KeyValue&lt;K, ScoredValue&lt;V&gt;&gt; multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3

bzpopmax(
    timeout: double,  // the timeout in seconds.
    keys: K...  // the keys.
) → KeyValue<K, ScoredValue<V>>  // KeyValue&lt;K, ScoredValue&lt;V&gt;&gt; multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3

Possible errors

ERR value is not an integer: RedisCommandExecutionException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

bzpopmax(
    timeout: long,  // the timeout in seconds.
    keys: K...  // the keys.
) → RedisFuture<KeyValue<K, ScoredValue<V>>>  // KeyValue&lt;K, ScoredValue&lt;V&gt;&gt; multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3

bzpopmax(
    timeout: double,  // the timeout in seconds.
    keys: K...  // the keys.
) → RedisFuture<KeyValue<K, ScoredValue<V>>>  // KeyValue&lt;K, ScoredValue&lt;V&gt;&gt; multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3

Possible errors

ERR value is not an integer: RedisCommandExecutionException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

bzpopmax(
    timeout: long,  // the timeout in seconds.
    keys: K...  // the keys.
) → Mono<KeyValue<K, ScoredValue<V>>>  // KeyValue&lt;K, ScoredValue&lt;V&gt;&gt; multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3

bzpopmax(
    timeout: double,  // the timeout in seconds.
    keys: K...  // the keys.
) → Mono<KeyValue<K, ScoredValue<V>>>  // KeyValue&lt;K, ScoredValue&lt;V&gt;&gt; multi-bulk containing the name of the key, the score and the popped member. @since 6.1.3

Possible errors

ERR value is not an integer: RedisCommandExecutionException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

BZPopMax(
    ctx: context.Context,
    timeout: time.Duration,
    keys: ...string
) → *ZWithKeyCmd

Possible errors

ERR value is not an integer: redis.Error

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

BZPopMax(
    keys: RedisKey[],
    timeout: double  // Server-side timeout for the wait. A value of 0 means to wait indefinitely.
) → Tuple<RedisKey, RedisValueWithScore>?  // A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires.

BZPopMax(
    key: RedisKey,  // The key to check.
    timeout: double  // Server-side timeout for the wait. A value of 0 means to wait indefinitely.
) → Tuple<RedisKey, RedisValueWithScore>?  // A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires.

Possible errors

ERR value is not an integer: RedisServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

BZPopMaxAsync(
    keys: RedisKey[],
    timeout: double  // Server-side timeout for the wait. A value of 0 means to wait indefinitely.
) → Task<Tuple<RedisKey, RedisValueWithScore>?>  // A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires.

BZPopMaxAsync(
    key: RedisKey,  // The key to check.
    timeout: double  // Server-side timeout for the wait. A value of 0 means to wait indefinitely.
) → Task<Tuple<RedisKey, RedisValueWithScore>?>  // A sorted set entry paired with its score, together with the key it was popped from, or nullif the server timeout expires.

Possible errors

ERR value is not an integer: RedisServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

bzpopmax(
    $keys: array,
    $timeout: int
) → array

Possible errors

ERR value is not an integer: Predis\Response\ServerException

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

bzpopmax(
    *args: Array<String>,  // one or multiple keys of the sorted sets
    timeout: Integer  // the maximum number of seconds to block
) → Array<String, String, Float>  // a tuple of key, member and score

Possible errors

ERR value is not an integer: Redis::CommandError

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

bzpopmax(
    key: K,
    timeout: f64
) → (Option<(String, String, f64)>)

Possible errors

ERR value is not an integer: ErrorKind::Server(ServerErrorKind::ResponseError)

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

bzpopmax(
    key: K,
    timeout: f64
) → (Option<(String, String, f64)>)

Possible errors

ERR value is not an integer: ErrorKind::Server(ServerErrorKind::ResponseError)

See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.

Available since:: Redis Open Source 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,
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.

BZPOPMAX is the blocking variant of the sorted set ZPOPMAX 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 highest 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 BZPOPMIN documentation for the exact semantics, since BZPOPMAX is identical to BZPOPMIN with the only difference being that it pops members with the highest scores instead of popping the ones with the lowest scores.

Required arguments

key [key ...]

One or more sorted-set keys to pop from.

timeout

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

Examples

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

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 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.