BRPOP
BRPOP key [key ...] timeout
- Group
- List
- Complexity
- O(N) where N is the number of keys given
- Arity
- -3 (at least 3 words, counting the command name)
- Flags
- write, blocking
- Keys
- first 1, last -2, step 1
- HotKV Cloud
- All plans
- On-Premise
- no license needed
BRPOP is the blocking form of RPOP. It works exactly like
BLPOP, but pops from the tail of the list instead of the
head. Keys are checked in the order given; if every list is empty or missing,
the connection waits until one of them receives an element or timeout
passes.
timeout is in seconds and can have a fractional part. 0 waits forever.
Inside MULTI / EXEC and inside scripts,
BRPOP never waits and replies at once as if the timeout had expired.
Return value
Section titled “Return value”| Case | RESP2 | RESP3 |
|---|---|---|
| Element popped | Two-element array: the key, then the element | Same |
| Timeout expired | Nil array | Null |
Errors:
ERR timeout is not a float or out of range,ERR timeout is negative, orERR timeout is out of rangefor a badtimeout.WRONGTYPEif a key reached before the first non-empty list holds a value that is not a list.
Examples
Section titled “Examples”127.0.0.1:6379> RPUSH jobs j1 j2(integer) 2127.0.0.1:6379> BRPOP jobs 01) "jobs"2) "j2"127.0.0.1:6379> BRPOP nothing 0.1(nil)(0.10s)Compatibility
Section titled “Compatibility”Same as Redis 7.4 and Valkey 8.
See also
Section titled “See also”Was this page helpful?
Thanks for the feedback.