Redis HLENコマンドの使い方 – ハッシュに含まれるフィールド数を取得する方法

このチュートリアルでは、RedisのHLENコマンドを使って、指定したキーに保存されているハッシュ値に含まれるフィールドの数を取得する方法を解説します。redis-cliからHLENコマンドを実行することで、ハッシュ内のフィールド総数を簡単に確認できます。

HLENコマンドの構文

redis host:port> HLEN <キー名>

指定したキーに対してHLENコマンドを実行すると、そのハッシュに登録されているフィールドの数が返されます。

実行結果（戻り値）

- (integer) ハッシュに含まれるフィールドの数
- 0：キーが存在しない場合
- エラー：キーは存在するが、保存されている値がハッシュ型ではない場合

使用例

以下は、実際にredis-cliでHLENコマンドを使用した例です。

# ハッシュを作成
redis host:port> HSET user:1 name "Taro" age 25 city "Tokyo"
(integer) 3

# フィールド数を取得
redis host:port> HLEN user:1
(integer) 3

# 存在しないキーを指定した場合
redis host:port> HLEN user:999
(integer) 0

このように、HSETで3つのフィールド（name、age、city）を持つハッシュを作成した場合、HLENは「3」を返します。キーが存在しない場合はエラーではなく「0」が返される点に注意してください。

補足ポイント

• HLENはO(1)の時間計算量で動作するため、フィールド数が多くても高速に処理されます。
• 文字列型やリスト型など、ハッシュ以外のデータ型が保存されたキーに対して実行すると、WRONGTYPEエラーが発生します。
• ハッシュ内のすべてのフィールドと値を確認したい場合は、HGETALLコマンドを併用すると便利です。

参考資料

1. HLENコマンド公式ドキュメント

以上が、Redisデータストアに保存されたハッシュ値に含まれるフィールド数を取得する方法の解説でした。この記事が役に立った場合は、ぜひコメント欄でご意見をお聞かせください。また、他の方にもシェアしていただければ幸いです。