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

BRPOPLPUSH Deprecated

As of Redis version 6.2.0, this command is regarded as deprecated.

It can be replaced by BLMOVE with the RIGHT and LEFT arguments when migrating or writing new code.

Syntax text Syntax diagram API methods

BRPOPLPUSH source destination timeout

Client:

brpoplpush(
    src: KeyT,
    dst: KeyT,
    timeout: Optional[Number] = 0
) → Union[Awaitable[Optional[str]], Optional[str]]

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.

brpoplpush(
    source: RedisKey,
    destination: RedisKey,
    timeout: number | string,
    callback?: Callback<string | null>
) → Result<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.

brpoplpush(
    source: String,
    destination: String,
    timeout: int  // seconds to block. A timeout of zero can be used to block indefinitely.
) → String  // The element being popped from source and pushed to destination @deprecated Use ListCommands#blmove(String, String, ListDirection, ListDirection, double) with ListDirection#RIGHT and ListDirection#LEFT. Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 6.2.0.

brpoplpush(
    source: String,
    destination: String,
    timeout: int  // seconds to block. A timeout of zero can be used to block indefinitely.
) → String  // The element being popped from source and pushed to destination @deprecated Use ListCommands#blmove(String, String, ListDirection, ListDirection, double) with ListDirection#RIGHT and ListDirection#LEFT. Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 6.2.0.

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.

brpoplpush(
    timeout: long,  // the timeout in seconds.
    source: K,  // the source key.
    destination: K  // the destination type: key.
) → V  // V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3

brpoplpush(
    timeout: double,  // the timeout in seconds.
    source: K,  // the source key.
    destination: K  // the destination type: key.
) → V  // V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @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.

brpoplpush(
    timeout: long,  // the timeout in seconds.
    source: K,  // the source key.
    destination: K  // the destination type: key.
) → RedisFuture<V>  // V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3

brpoplpush(
    timeout: double,  // the timeout in seconds.
    source: K,  // the source key.
    destination: K  // the destination type: key.
) → RedisFuture<V>  // V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @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.

brpoplpush(
    timeout: long,  // the timeout in seconds.
    source: K,  // the source key.
    destination: K  // the destination type: key.
) → Mono<V>  // V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @since 6.1.3

brpoplpush(
    timeout: double,  // the timeout in seconds.
    source: K,  // the source key.
    destination: K  // the destination type: key.
) → Mono<V>  // V bulk-string-reply the element being popped from source and pushed to destination. If timeout is reached, a. @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.

BRPopLPush(
    ctx: context.Context,
    source: Any,
    destination: string,
    timeout: time.Duration
) → *StringCmd

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.

BRPopLPush(
    source: RedisKey,  // The key of the source list.
    destination: RedisKey,  // The key of the destination list.
    timeout: double  // Server-side timeout for the wait. A value of 0 means to wait indefinitely.
) → RedisValue?  // The element being popped and pushed, or null if 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.

BRPopLPushAsync(
    source: RedisKey,  // The key of the source list.
    destination: RedisKey,  // The key of the destination list.
    timeout: double  // Server-side timeout for the wait. A value of 0 means to wait indefinitely.
) → Task<RedisValue?>  // The element being popped and pushed, or null if 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.

brpoplpush(
    $source: string,
    $destination: string,
    $timeout: int|float
) → string|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.

brpoplpush(
    source: String,  // source key
    destination: String,  // destination key
    timeout: Float, Integer  // timeout in seconds
) → nil, String  // the element was popped and pushed

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.

brpoplpush(
    srckey: S,
    dstkey: D,
    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.

brpoplpush(
    srckey: S,
    dstkey: D,
    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.2.0
Time complexity:: O(1)
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.

BRPOPLPUSH is the blocking variant of RPOPLPUSH. When source contains elements, this command behaves exactly like RPOPLPUSH. When used inside a MULTI/EXEC block or a Lua script, this command behaves exactly like RPOPLPUSH. When source is empty, Redis will block the connection until another client pushes to it or until timeout is reached. A timeout of zero can be used to block indefinitely.

See RPOPLPUSH for more information.

Required arguments

source

The key of the source list.

destination

The key of the destination list.

timeout

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

Details

Pattern: reliable queue

Please see the pattern description in the RPOPLPUSH documentation.

Pattern: circular list

Please see the pattern description in the RPOPLPUSH documentation.

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active	Deprecated as of Redis v6.2.0.

Return information

RESP2 RESP3

One of the following:

Bulk string reply: the element being popped from source and pushed to destination.
Nil reply: the timeout is reached.

History

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