【Redis入門】HSET・HSETNX・HMSETコマンドでハッシュのフィールドに値を設定する方法

このチュートリアルでは、Redisのキーに格納されたハッシュ値の各フィールドに対して値を設定する方法を解説します。使用するのは HSET、HSETNX、HMSET の3つのコマンドです。それぞれの構文、戻り値、実行例を順番に見ていきましょう。

HSETコマンドとは

HSET コマンドは、指定したキーに格納されているハッシュ内の指定フィールドに値を設定します。

• フィールドがすでに存在する場合は、既存の値が上書きされます。
• キーが存在しない場合は、設定操作の前にハッシュを保持する新しいキーが自動的に作成されます。
• キーは存在するものの、格納されている値がハッシュ型でない場合はエラーが返されます。

構文

redis host:post> HSET <keyname> <field> <value>

戻り値

- 1 (integer)：フィールドが新規で、値が設定された場合
- 0 (integer)：フィールドが既に存在し、値が上書きされた場合
- エラー：キーは存在するが、値がハッシュ型ではない場合

実行例

HSETNXコマンドとは

HSETNX コマンドは、ハッシュ内にそのフィールドが存在しない場合のみ値を設定します。フィールドがすでに存在する場合、この操作は何も行わず、既存の値は変更されません。キーが存在しない場合は、HSETと同様に新しいキーが作成されます。

「既存の値を絶対に上書きしたくない」というケースで役立つコマンドです。

構文

redis host:post> HSETNX <keyname> <field> <value>

戻り値

- 1 (integer)：フィールドが新規で、値が設定された場合
- 0 (integer)：フィールドが既に存在し、操作が実行されなかった場合
- エラー：キーは存在するが、値がハッシュ型ではない場合

実行例

HMSETコマンドとは

HMSET コマンドは、複数のフィールド／値ペアを一度にハッシュへ設定できます。指定したいずれかのフィールドがすでに存在する場合は、その値が上書きされます。キーが存在しない場合は、新しいキーが作成されます。

補足： HMSETはRedis 4.0.0以降で非推奨（deprecated）となっており、現在はHSETコマンド自体が複数のフィールド／値ペアを受け付けられるようになっています。新規開発ではHSETの利用が推奨されます。

構文

redis host:post> HMSET <keyname> <field> <value> [ <field> <value> ]

戻り値

- OK (simple string)：正常に設定された場合
- エラー：キーは存在するが、値がハッシュ型ではない場合

実行例

参考ドキュメント

1. HSETコマンド公式ドキュメント
2. HSETNXコマンド公式ドキュメント
3. HMSETコマンド公式ドキュメント

以上、Redisデータストアに格納されたハッシュのフィールドに値を設定する方法についての解説でした。この記事が役に立ったら、ぜひコメントで感想を共有したり、周りの方にもシェアしてください。

<- ハッシュ関連コマンド一覧へ戻る