RENAME

Syntax text Syntax diagram API methods

RENAME key newkey

Client:

rename(
    src: KeyT,
    dst: KeyT
) → str

RENAME(
    key: RedisArgument,
    newKey: RedisArgument
) → Any

rename(
    oldkey: byte[],
    newkey: byte[]
) → String  // Status code reply

rename(
    oldkey: String,
    newkey: String
) → String  // Status code reply

rename(
    key: K,  // the key.
    newKey: K  // the newkey.
) → String  // String simple-string-reply

rename(
    key: K,  // the key.
    newKey: K  // the newkey.
) → RedisFuture<String>  // String simple-string-reply

rename(
    key: K,  // the key.
    newKey: K  // the newkey.
) → Mono<String>  // String simple-string-reply

Rename(
    ctx: context.Context,
    key: string,
    newkey: string
) → *StatusCmd

KeyRename(
    key: RedisKey,  // The key to rename.
    newKey: RedisKey,  // The new key name.
    flags: CommandFlags  // The flags to use for this operation.
) → bool  // true if the key was renamed, false otherwise.

KeyRenameAsync(
    key: RedisKey,  // The key to rename.
    newKey: RedisKey,  // The new key name.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<bool>  // true if the key was renamed, false otherwise.

rename(
    $srcKey: string,
    $dstKey: string
) → bool

Available since:: Redis Open Source 1.0.0
Time complexity:: O(1)
ACL categories:: @keyspace, @write, @slow,
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.

Renames key to newkey. It returns an error when key does not exist. If newkey already exists it is overwritten, when this happens RENAME executes an implicit DEL operation, so if the deleted key contains a very big value it may cause high latency even if RENAME itself is usually a constant-time operation.

In Cluster mode, both key and newkey must be in the same hash slot, meaning that in practice only keys that have the same hash tag can be reliably renamed in cluster.

Required arguments

key

The key to rename.

newkey

The new key name. An existing key with this name is overwritten.

Examples

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active*	✅ Standard ✅ Active-Active*	For Active-Active or clustered databases, the original key and new key must be in the same hash slot. *Not supported for stream consumer group info.

Return information

RESP2 RESP3

Simple string reply: OK.

History

Starting with Redis version 3.2.0: The command no longer returns an error when source and destination names are the same.