rename.3valkey - Man Page

RENAME key newkey

Renames key to newkey. It returns an error when key does not exist.

If newkey already exists, it is overwritten. By default, Valkey uses implicit lazy freeing (similar to UNLINK), so large values are released asynchronously. If lazy freeing is disabled and synchronous deletion is configured, overwriting a key with a very large value may cause high latency.

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.

valkey-protocol(7) Simple string reply: OK.

O(1)

@keyspace @slow @write

• Available since: 1.0.0

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"

copy(3valkey), del(3valkey), dump(3valkey), exists(3valkey), expire(3valkey), expireat(3valkey), expiretime(3valkey), keys(3valkey), migrate(3valkey), move(3valkey), object(3valkey), object-encoding(3valkey), object-freq(3valkey), object-help(3valkey), object-idletime(3valkey), object-refcount(3valkey), persist(3valkey), pexpire(3valkey), pexpireat(3valkey), pexpiretime(3valkey), pttl(3valkey), randomkey(3valkey), renamenx(3valkey), restore(3valkey), scan(3valkey), sort(3valkey), sort_ro(3valkey), touch(3valkey), ttl(3valkey), type(3valkey), unlink(3valkey), wait(3valkey), waitaof(3valkey)

elinks.conf(5).