diff options
Diffstat (limited to 'iredis/data/commands/rename.md')
| -rw-r--r-- | iredis/data/commands/rename.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/iredis/data/commands/rename.md b/iredis/data/commands/rename.md new file mode 100644 index 0000000..471ecf4 --- /dev/null +++ b/iredis/data/commands/rename.md @@ -0,0 +1,21 @@ +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. + +@return + +@simple-string-reply + +@examples + +```cli +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.
\ No newline at end of file |