RPOPLPUSH - Upstash Documentation

Warning

Prefer LMOVE with RIGHT and LEFT in new code: LMOVE <source> <destination> RIGHT LEFT.

Use RPOPLPUSH to atomically move an element from the tail of one list to the head of another, returning the element.

If the source is empty nothing happens and the reply is null. Source and destination may be the same key, which rotates the list: the tail element becomes the new head, so repeated calls cycle through a list of items forever, a handy pattern for round-robin scheduling.

LMOVE does the same thing but lets you choose both ends, and BRPOPLPUSH is the blocking form.

Syntax#

RPOPLPUSH <source> <destination>

Arguments#

Argument	Required	Repeatable	Description
`<source>`	Yes	No	Redis key used as source.
`<destination>`	Yes	No	Redis key used as destination.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Bulk string or Null bulk string or null array
RESP3	Bulk string or Null

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

RPOPLPUSH source-key destination-key

@upstash/redis

Note

This command is not supported yet in @upstash/redis.

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.rpoplpush("source-key", "destination-key")print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.rpoplpush("source-key", "destination-key");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.rPopLPush("source-key", "destination-key");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.rpoplpush("source-key", "destination-key")print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.RPopLPush(context.Background(), "source-key", "destination-key").Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.rpoplpush("source-key", "destination-key");  System.out.println(result);}

redis-rs

use redis::TypedCommands;fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let result = connection.rpoplpush("source-key", "destination-key")?;    println!("{result:?}");    Ok(())}