{"id":26238,"date":"2022-07-06T11:07:39","date_gmt":"2022-07-06T01:07:39","guid":{"rendered":"https:\/\/database.guide\/?p=26238"},"modified":"2022-07-08T12:02:11","modified_gmt":"2022-07-08T02:02:11","slug":"redis-rename-command-explained","status":"publish","type":"post","link":"https:\/\/database.guide\/redis-rename-command-explained\/","title":{"rendered":"Redis RENAME Command Explained"},"content":{"rendered":"\n

In Redis, the RENAME<\/code> command renames a key. It allows us to give a key a new name.<\/p>\n\n\n\n\n\n\n\n

Syntax<\/h2>\n\n\n\n

The syntax goes like this:<\/p>\n\n\n\n

RENAME key newkey<\/code><\/pre>\n\n\n\n
Where key<\/em><\/code> is the old key name and newkey<\/em><\/code> is the new one.<\/p>\n\n\n\n
Example<\/h2>\n\n\n\n
Here’s an example to demonstrate:<\/p>\n\n\n\n
RENAME colour color<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
OK<\/pre>\n\n\n\n
In this case I renamed a key called colour<\/code> to color<\/code>.<\/p>\n\n\n\n
Let’s check its value:<\/p>\n\n\n\n
GET color<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
\"Red\"<\/pre>\n\n\n\n
If we use the KEYS<\/code> command to check whether the original key exists, we can see that it doesn’t:<\/p>\n\n\n\n
KEYS colour<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(empty array)<\/pre>\n\n\n\n
When the New Key Already Exists<\/h2>\n\n\n\n
If the new key already exists, it is overwritten. More specifically, Redis performs an implicit DEL<\/code> operation (which could impact performance if the key’s value is large).<\/p>\n\n\n\n
Here’s an example of renaming a key to key that already exists:<\/p>\n\n\n\n
RENAME named_color color<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
OK<\/pre>\n\n\n\n
Here, the new key is the same one I used in the previous example, but the old key is a different one. <\/p>\n\n\n\n
Now when I get the value of the color<\/code> key, it contains a different value:<\/p>\n\n\n\n
GET color<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
\"Green\"<\/pre>\n\n\n\n
In the previous example, this key had a value of Red<\/code>, but now it has a value of Green<\/code>. That’s because the named_color<\/code> key had a value of Green<\/code>.<\/p>\n\n\n\n
When the Old Key Doesn’t Exist<\/h2>\n\n\n\n
If we try to rename a key that doesn’t exist, an error is returned:<\/p>\n\n\n\n
RENAME nonexistentkey newkey<\/code><\/pre>\n\n\n\n
Result:<\/p>\n\n\n\n
(error) ERR no such key<\/pre>\n\n\n\n
Also see the Redis RENAMENX<\/a><\/code> command, which only renames the key if the new one doesn’t already exist.<\/p>\n","protected":false},"excerpt":{"rendered":"
In Redis, the RENAME command renames a key. It allows us to give a key a new name.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[153],"tags":[154,20],"class_list":["post-26238","post","type-post","status-publish","format-standard","hentry","category-redis","tag-commands","tag-what-is"],"_links":{"self":[{"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/posts\/26238","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/comments?post=26238"}],"version-history":[{"count":5,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/posts\/26238\/revisions"}],"predecessor-version":[{"id":26391,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/posts\/26238\/revisions\/26391"}],"wp:attachment":[{"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/media?parent=26238"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/categories?post=26238"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/database.guide\/wp-json\/wp\/v2\/tags?post=26238"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}