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

BRPOP

Syntax text Syntax diagram API methods

BRPOP key [key ...] timeout

Client:

brpop(
    keys: List,
    timeout: Optional[Number] = 0
) → Union[Awaitable[list], list]

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.

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

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

brpop(
    ...keys: RedisKey[],
    timeout: number | string
) → Result<[string, string] | null, Context>

brpop(
    keys: RedisKey[],
    timeout: number | string
) → Result<[string, 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.

brpop(
    timeout: int,
    keys: String...
) → List<String>

brpop(
    timeout: double,
    keys: String...
) → KeyValue<String, String>

brpop(
    timeout: int,
    key: String
) → List<String>

brpop(
    timeout: double,
    key: String
) → KeyValue<String, String>

brpop(
    timeout: int,
    keys: String...
) → List<String>

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.

brpop(
    timeout: long,  // the timeout in seconds.
    keys: K...  // the keys.
) → KeyValue<K, V>  // KeyValue&lt;K,V&gt; array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3

brpop(
    timeout: double,  // the timeout in seconds.
    keys: K...  // the keys.
) → KeyValue<K, V>  // KeyValue&lt;K,V&gt; array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @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.

brpop(
    timeout: long,  // the timeout in seconds.
    keys: K...  // the keys.
) → RedisFuture<KeyValue<K, V>>  // KeyValue&lt;K,V&gt; array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3

brpop(
    timeout: double,  // the timeout in seconds.
    keys: K...  // the keys.
) → RedisFuture<KeyValue<K, V>>  // KeyValue&lt;K,V&gt; array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @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.

brpop(
    timeout: long,  // the timeout in seconds.
    keys: K...  // the keys.
) → Mono<KeyValue<K, V>>  // KeyValue&lt;K,V&gt; array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @since 6.1.3

brpop(
    timeout: double,  // the timeout in seconds.
    keys: K...  // the keys.
) → Mono<KeyValue<K, V>>  // KeyValue&lt;K,V&gt; array-reply specifically: A null multi-bulk when no element could be popped and the timeout expired. A two-element multi-bulk with the first element being the name of the key where an element was popped and the second element being the value of the popped element. @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.

BRPop(
    ctx: context.Context,
    timeout: time.Duration,
    keys: ...string
) → *StringSliceCmd

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.

BRPop(
    keys: RedisKey[],
    timeout: double  // Server-side timeout for the wait. A value of 0 means to wait indefinitely.
) → Tuple<RedisKey, RedisValue>?  // A value, together with the key it was popped from, or null if the server timeoutexpires.

BRPop(
    key: RedisKey,  // The key to check.
    timeout: double  // Server-side timeout for the wait. A value of 0 means to wait indefinitely.
) → Tuple<RedisKey, RedisValue>?  // A value, together with the key it was popped from, or null if the server timeoutexpires.

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.

BRPopAsync(
    keys: RedisKey[],
    timeout: double  // Server-side timeout for the wait. A value of 0 means to wait indefinitely.
) → Task<Tuple<RedisKey, RedisValue>?>  // A value, together with the key it was popped from, or null if the server timeoutexpires.

BRPopAsync(
    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, RedisValue>?>  // A value, together with the key it was popped from, or null if the server timeoutexpires.

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.

brpop(
    $keys: array|string,
    $timeout: int|float
) → array|null

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.

brpop(
    *args: String, Array<String>,  // one or more keys to perform the blocking pop on
    timeout: Float, Integer  // timeout in seconds
) → nil, [String, String]  // tuple of the list that was popped from and element

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.

brpop(
    key: K,
    timeout: f64
) → (Option<[String

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.

brpop(
    key: K,
    timeout: f64
) → (Option<[String

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 2.0.0
Time complexity:: O(N) where N is the number of provided keys.
ACL categories:: @write, @list, @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.

BRPOP is a blocking list pop primitive. It is the blocking version of RPOP because it blocks the connection when there are no elements to pop from any of the given lists. An element is popped from the tail of the first list that is non-empty, with the given keys being checked in the order that they are given.

See the BLPOP documentation for the exact semantics, since BRPOP is identical to BLPOP with the only difference being that it pops elements from the tail of a list instead of popping from the head.

Required arguments

key [key ...]

One or more keys of lists to operate on.

timeout

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

Examples

redis> DEL list1 list2
(integer) 0
redis> RPUSH list1 a b c
(integer) 3
redis> BRPOP list1 list2 0
1) "list1"
2) "c"

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: no element could be popped and the timeout expired.
Array reply: the key from which the element was popped and the value of the popped element

History

Starting with Redis version 6.0.0: timeout is interpreted as a double instead of an integer.