BRPOP

Syntax text Syntax diagram API methods

BRPOP key [key ...] timeout

Client:

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

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>

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

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

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

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

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.

BRPop(
    db: Any,  // The IDatabase class where this extension method is applied.
    [key]: Any,
    timeout: Any  // Server-side timeout for the wait. A value of 0 means to wait indefinitely.
) → return  // A value, together with the key it was popped from, or null if the server timeoutexpires.

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

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

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

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.

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.

Products

Tools

Get Redis

Connect

Learn

Latest

See how it works

BRPOP

Examples

Redis Software and Redis Cloud compatibility

Return information

History