summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/rename.md
blob: 5a38f635d3dd0e5cd7d58a70b8fac97fbdaa05c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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.

@history

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

@return

@simple-string-reply

@examples

```cli
SET mykey "Hello"
RENAME mykey myotherkey
GET myotherkey
```