Redis HGETALLコマンドの使い方 – ハッシュに含まれるすべてのフィールドと値のペアを一括取得する方法

このチュートリアルでは、Redisのキーに保存されたハッシュ値に含まれるすべてのフィールドと値のペアを取得する方法について解説します。この操作には、RedisのHGETALLコマンドを使用します。

HGETALLコマンドとは

HGETALLコマンドは、指定したキーに保存されているハッシュ値に含まれるすべてのフィールドと、それぞれに関連付けられた値を返すコマンドです。

動作のポイントは以下の通りです。

• キーが存在しない場合は、空のリストが返されます(エラーにはなりません)。
• キーは存在するが、その値がハッシュ型ではない場合は、エラーが返されます。

構文

redis host:port> HGETALL <keyname>

戻り値

• (array) reply: ハッシュ内のフィールドとその値のリストを表す配列
• 空のリスト: キーが存在しない場合
• エラー: キーは存在するが、保存されている値がハッシュ型でない場合

使用例

まずHSETコマンドでハッシュに複数のフィールドと値を設定し、その後HGETALLコマンドを実行すると、登録済みのすべてのフィールドと値のペアが一括で取得できます。実行結果は「フィールド名」と「値」が交互に並ぶフラットな配列として返される点に注意してください。

# ハッシュにデータを設定
redis host:port> HSET user:1 name "Taro" age "25" city "Tokyo"

# すべてのフィールドと値を取得
redis host:port> HGETALL user:1
1) "name"
2) "Taro"
3) "age"
4) "25"
5) "city"
6) "Tokyo"

まとめ

HGETALLコマンドを使えば、Redisデータストア内のハッシュに含まれるすべてのフィールドと値のペアを簡単に取得できます。ただし、大きなハッシュに対して実行すると大量のデータが一度に返されるため、パフォーマンスへの影響にも留意しましょう。

この記事が役に立った場合は、ぜひコメント欄でご意見をお聞かせください。また、他の方にもシェアしていただけると嬉しいです。