COPY - Upstash Documentation

Use COPY to copy the value stored at one key to another key. The destination gets an independent deep copy of the value, so later changes to either key do not affect the other, and the source key’s remaining time to live is copied along with it. Any type can be copied. By default the command does nothing and returns 0 when the destination key already exists; REPLACE overwrites it instead. DB selects the destination database index, which on Upstash is always 0.

Syntax

COPY <source> <destination> [DB <destination-db>] [REPLACE]

Arguments

Argument	Required	Repeatable	Description
`<source>`	Yes	No	Redis key used as source.
`<destination>`	Yes	No	Redis key used as destination.
`DB <destination-db>`	No	No	Index of the database to copy the key into.
`REPLACE`	No	No	Allow replacement of an existing 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	Integer: `1` if the key was copied, `0` otherwise
RESP3	Integer: `1` if the key was copied, `0` otherwise

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

COPY source-key destination-key

@upstash/redis

import { Redis } from "@upstash/redis";

const redis = Redis.fromEnv();
const result = await redis.copy("source-key", "destination-key");
console.log(result);

upstash_redis

from upstash_redis import Redis

redis = Redis.from_env()
result = redis.copy("source-key", "destination-key")
print(result)

ioredis

import Redis from "ioredis";

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

redis-py

import os
import redis

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

go-redis

package main

import (
    "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.Copy(context.Background(), "source-key", "destination-key", 0, false).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.copy("source-key", "destination-key", false);
  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.copy("source-key", "destination-key", redis::CopyOptions::default())?;
    println!("{result:?}");
    Ok(())
}

​Syntax

​Arguments

​Response

​Examples

Syntax

Arguments

Response

Examples