RENAME

Syntax
RENAME key newkey
Available since:
Redis Open Source 1.0.0
Time complexity:
O(1)
ACL categories:
@keyspace, @write, @slow,
Compatibility:
Redis Software and Redis Cloud compatibility

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.

Examples

SET mykey "Hello" RENAME mykey myotherkey GET myotherkey

Behavior change history

  • >= 3.2.0: The command no longer returns an error when source and destination names are the same.

Redis Software and Redis Cloud compatibility

Redis
Enterprise		 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

RATE THIS PAGE
Back to top ↑