RENAME · Valkey

RENAME

Renames a key and overwrites the destination.

Usage

RENAME key newkey

Description

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.

Reply

Simple string reply: OK.

Complexity

O(1)

ACL Categories

@keyspace @slow @write

Examples

127.0.0.1:6379> SET mykey "Hello"
OK
127.0.0.1:6379> RENAME mykey myotherkey
OK
127.0.0.1:6379> GET myotherkey
"Hello"

History

See also

COPY, DEL, DUMP, EXISTS, EXPIRE, EXPIREAT, EXPIRETIME, KEYS, MIGRATE, MOVE, OBJECT, OBJECT ENCODING, OBJECT FREQ, OBJECT HELP, OBJECT IDLETIME, OBJECT REFCOUNT, PERSIST, PEXPIRE, PEXPIREAT, PEXPIRETIME, PTTL, RANDOMKEY, RENAMENX, RESTORE, SCAN, SORT, SORT_RO, TOUCH, TTL, TYPE, UNLINK, WAIT, WAITAOF.