Redisでキー名を変更する方法を解説 – RENAME / RENAMENXコマンドの使い方

このチュートリアルでは、Redisデータストアに保存されたキーの名前を変更する方法について、RENAMEコマンドとRENAMENXコマンドを使って詳しく解説します。

RENAMEコマンドとは

RENAMEコマンドは、既存のキーを古い名前から新しい名前に変更するためのコマンドです。もし新しい名前のキーがすでに存在している場合は、そのキーが上書きされ、古い名前のキーには暗黙的にDELコマンドが実行されて削除されます。新しい名前のキーが存在しない場合は、単純に古い名前が新しい名前に変更されます。

構文

redis host:port> RENAME <old name> <new name>

戻り値

- キーの名前変更に成功した場合：文字列（OK）が返される
- 古い名前のキーが存在しない場合：エラーが返される

実行例

RENAMENXコマンドとは

RENAMENXコマンドは、新しい名前のキーがまだ存在しない場合にのみ、キーの名前を変更します。新しい名前のキーがすでに存在する場合は0が返され、名前の変更は行われません。一方、新しい名前のキーが存在しなければ、古い名前のキーが新しい名前に変更されます。既存のキーを誤って上書きしたくない場合に便利なコマンドです。

構文

redis host:port> RENAMENX <old name> <new name>

戻り値

- キーの名前変更に成功した場合：1が返される
- 新しい名前のキーがすでに存在する場合：0が返される
- 古い名前のキーが存在しない場合：エラーが返される

実行例

参考資料

1. RENAMEコマンド公式ドキュメント
2. RENAMENXコマンド公式ドキュメント

以上、Redisデータストアに保存されたキーの名前を変更する方法について解説しました。RENAMEとRENAMENXの違いを理解しておけば、状況に応じて適切なコマンドを選択できるようになります。この記事が役に立ったと思われた方は、ぜひコメント欄でご意見をお聞かせください。また、他の方にもシェアしていただけると嬉しいです。