Redis LRANGEコマンドの使い方 – リスト値の全要素を取得する方法を解説

このチュートリアルでは、Redisデータストアに保存されたキーのリスト値から、すべての要素を取得する方法を解説します。そのために使用するのが、RedisのLRANGEコマンドです。

LRANGEコマンドとは

LRANGEコマンドは、指定したキーに保存されているリスト値から、指定されたオフセット（範囲）に基づいて1つ以上の要素を返すコマンドです。開始位置（start）と終了位置（end）の2つの引数を受け取り、どちらも範囲に含まれます。

これらのオフセットは0始まりのインデックスで指定します。つまり、「0」が最初の要素、「1」が2番目の要素を意味します。また、負の数を使うことでリストの末尾からの位置を指定することも可能です。「-1」が最後の要素、「-2」が最後から2番目の要素となります。

範囲外のオフセットが指定された場合の挙動

範囲外のオフセットが指定された場合は、以下のように処理されます。

1. start > end の場合： 結果として空のリストが返されます。
2. end がリストのサイズを超えている場合： endオフセットはリストの最後の要素のインデックスに自動的に置き換えられます。

なお、キーは存在するものの、その値がリスト型ではない場合にはエラーが返されます。

構文

redis host:port> LRANGE <keyname> <start> <end>

戻り値

- 指定されたオフセット範囲内の要素のリスト（配列形式で返却）
- キーが存在するが値がリスト型でない場合はエラー

リストのすべての要素を取得する方法

リスト値のすべての要素を取得したい場合は、開始オフセットに「0」、終了オフセットに「-1」を指定してLRANGEコマンドを実行します。これにより、先頭から末尾までの全要素が一度に取得できます。

LRANGE <keyname> 0 -1

実行例

参考資料

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

以上が、Redisデータストアに保存されたリスト値のすべての要素を取得する方法でした。この記事が役に立ったと思われた方は、ぜひコメント欄でご意見をお聞かせください。また、他の方にもシェアしていただけると嬉しいです。

<- リスト系コマンド一覧へ戻る