summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/renamenx.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/renamenx.md')
-rw-r--r--iredis/data/commands/renamenx.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/iredis/data/commands/renamenx.md b/iredis/data/commands/renamenx.md
new file mode 100644
index 0000000..c132af4
--- /dev/null
+++ b/iredis/data/commands/renamenx.md
@@ -0,0 +1,20 @@
+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.
+
+@return
+
+@integer-reply, specifically:
+
+* `1` if `key` was renamed to `newkey`.
+* `0` if `newkey` already exists.
+
+@examples
+
+```cli
+SET mykey "Hello"
+SET myotherkey "World"
+RENAMENX mykey myotherkey
+GET myotherkey
+```