RENAMENX key newkey

Available since 1.0.0.

Time complexity: O(1)

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

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.

*History

  • <= 3.2.0: Before Redis 3.2.0, an error is returned if source and destination names are the same.

*Return value

Integer reply, specifically:

  • 1 if key was renamed to newkey.
  • 0 if newkey already exists.

*Examples

redis> SET mykey "Hello"

  1. "OK"

redis> SET myotherkey "World"

  1. "OK"

redis> RENAMENX mykey myotherkey

  1. (integer) 0

redis> GET myotherkey

  1. "World"
redis>