BLMOVE

Syntax text Syntax diagram API methods

BLMOVE source destination <LEFT | RIGHT> <LEFT | RIGHT> timeout

Client:

blmove(
    first_list: str,
    second_list: str,
    timeout: int,
    src: str = "LEFT",
    dest: str = "RIGHT"
) → ResponseT

blmove(
    srcKey: String,
    dstKey: String,
    to: ListDirection from final ListDirection,  // can be LEFT or RIGHT
    timeout: double  // seconds to block. A timeout of zero can be used to block indefinitely.
) → String  // The element being popped and pushed

blmove(
    srcKey: String,
    dstKey: String,
    from: ListDirection,  // can be LEFT or RIGHT
    to: ListDirection,  // can be LEFT or RIGHT
    timeout: double  // seconds to block. A timeout of zero can be used to block indefinitely.
) → String  // The element being popped and pushed

blmove(
    source: K,  // the source key.
    destination: K,  // the destination type: key.
    args: LMoveArgs,  // command arguments to configure source and destination directions.
    timeout: long  // the timeout in seconds.
) → V  // V bulk-string-reply the element being popped and pushed. @since 6.1.3

blmove(
    source: K,  // the source key.
    destination: K,  // the destination type: key.
    args: LMoveArgs,  // command arguments to configure source and destination directions.
    timeout: double  // the timeout in seconds.
) → V  // V bulk-string-reply the element being popped and pushed. @since 6.1.3

blmove(
    source: K,  // the source key.
    destination: K,  // the destination type: key.
    args: LMoveArgs,  // command arguments to configure source and destination directions.
    timeout: long  // the timeout in seconds.
) → RedisFuture<V>  // V bulk-string-reply the element being popped and pushed. @since 6.1.3

blmove(
    source: K,  // the source key.
    destination: K,  // the destination type: key.
    args: LMoveArgs,  // command arguments to configure source and destination directions.
    timeout: double  // the timeout in seconds.
) → RedisFuture<V>  // V bulk-string-reply the element being popped and pushed. @since 6.1.3

blmove(
    source: K,  // the source key.
    destination: K,  // the destination type: key.
    args: LMoveArgs,  // command arguments to configure source and destination directions.
    timeout: long  // the timeout in seconds.
) → Mono<V>  // V bulk-string-reply the element being popped and pushed. @since 6.1.3

blmove(
    source: K,  // the source key.
    destination: K,  // the destination type: key.
    args: LMoveArgs,  // command arguments to configure source and destination directions.
    timeout: double  // the timeout in seconds.
) → Mono<V>  // V bulk-string-reply the element being popped and pushed. @since 6.1.3

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

BLMove(
    source: RedisKey,  // The key of the source list.
    destination: RedisKey,  // The key of the destination list.
    sourceSide: ListSide,  // What side of the source list to remove from.
    destinationSide: ListSide,  // What side of the destination list to move to.
    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.

ListMove(
    sourceKey: RedisKey,  // The key of the list to remove from.
    destinationKey: RedisKey,  // The key of the list to move to.
    sourceSide: ListSide,  // What side of the sourceKey list to remove from.
    destinationSide: ListSide,  // What side of the destinationKey list to move to.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The element being popped and pushed or Null if there is no element to move.

ListMove(
    sourceKey: RedisKey,  // The key of the list to remove from.
    destinationKey: RedisKey,  // The key of the list to move to.
    sourceSide: ListSide,  // What side of the sourceKey list to remove from.
    destinationSide: ListSide,  // What side of the destinationKey list to move to.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The element being popped and pushed or Null if there is no element to move.

ListMove(
    sourceKey: RedisKey,  // The key of the list to remove from.
    destinationKey: RedisKey,  // The key of the list to move to.
    sourceSide: ListSide,  // What side of the sourceKey list to remove from.
    destinationSide: ListSide,  // What side of the destinationKey list to move to.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The element being popped and pushed or Null if there is no element to move.

ListMove(
    sourceKey: RedisKey,  // The key of the list to remove from.
    destinationKey: RedisKey,  // The key of the list to move to.
    sourceSide: ListSide,  // What side of the sourceKey list to remove from.
    destinationSide: ListSide,  // What side of the destinationKey list to move to.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The element being popped and pushed or Null if there is no element to move.

blmove(
    $source: string,
    $destination: string,
    $where: string,
    $to: string,
    $timeout: int
) → string

blmove(
    srckey: S,
    dstkey: D,
    src_dir: Direction,
    dst_dir: Direction,
    timeout: f64
) → (Option<String>)

blmove(
    srckey: S,
    dstkey: D,
    src_dir: Direction,
    dst_dir: Direction,
    timeout: f64
) → (Option<String>)

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

BLMOVE is the blocking variant of LMOVE. When source contains elements, this command behaves exactly like LMOVE. When used inside a MULTI/EXEC block or a Lua script, this command behaves exactly like LMOVE. When source is empty, Redis will block the connection until another client pushes to it or until timeout (a double value specifying the maximum number of seconds to block) is reached. A timeout of zero can be used to block indefinitely.

This command comes in place of the now deprecated BRPOPLPUSH. Doing BLMOVE RIGHT LEFT is equivalent.

See LMOVE for more information.

Required arguments

source

The key of the source list.

destination

The key of the destination list.

LEFT | RIGHT

The end of source to pop the element from: LEFT (head) or RIGHT (tail).

LEFT | RIGHT

The end of destination to push the element to: LEFT (head) or RIGHT (tail).

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

Pattern: circular list

Please see the pattern description in the LMOVE documentation.

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:

Bulk string reply: the element being popped from the source and pushed to the destination.
Nil reply: the operation timed-out