SMOVE - Upstash Documentation

Use SMOVE to move a member from one set to another atomically.

The reply is 1 when the member was moved and 0 when it was not in the source set, in which case nothing changes. If the member already exists in the destination it is simply removed from the source. The destination is created when it does not exist, and the source is deleted when its last member leaves.

Because the removal and the insertion happen as one step, this is the safe way to move an item between states, such as from a pending set to a done set, without a window in which it is in both or in neither.

Syntax#

SMOVE <source> <destination> <member>

Arguments#

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

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	Integer: `1` if the member was moved, `0` if it is not in the source set
RESP3	Integer: `1` if the member was moved, `0` if it is not in the source set

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

SMOVE source-key destination-key member

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.sadd("original", "a", "b", "c");const moved =  await redis.smove("original", "destination", "a");// moved:       1// original:    ["b", "c"]// destination: ["a"]

upstash_redis

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

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.smove("source-key", "destination-key", "member");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.sMove("source-key", "destination-key", "member");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.smove("source-key", "destination-key", "member")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.SMove(context.Background(), "source-key", "destination-key", "member").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.smove("source-key", "destination-key", "member");  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.smove("source-key", "destination-key", "member")?;    println!("{result:?}");    Ok(())}