RENAMENX - Upstash Documentation

Use RENAMENX to rename a key only when the new name is not already in use.

The reply is 1 when the rename happened and 0 when the destination already existed and nothing was changed; renaming a key that does not exist returns an error. Because the check and the rename are one atomic step, the command can serve as a way to claim a name: only one of several clients trying to rename onto the same destination succeeds.

Syntax#

RENAMENX <key> <newkey>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<newkey>`	Yes	No	Redis key used as newkey.

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 renamed, `0` if the destination already exists
RESP3	Integer: `1` if the key was renamed, `0` if the destination already exists

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

RENAMENX old-key new-key

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const renamed = await redis.renamenx("old", "new");

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.renamenx("old-key", "new-key")print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.renamenx("old-key", "new-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.renameNX("old-key", "new-key");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.renamenx("old-key", "new-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.RenameNX(context.Background(), "old-key", "new-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.renamenx("old-key", "new-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.rename_nx("old-key", "new-key")?;    println!("{result:?}");    Ok(())}