Redis LTRIM – Redisデータストアに保存された既存のリストをトリミングする方法

このチュートリアルでは、Redisデータストア内のキーに保存された既存のリスト値をトリミング(切り詰め)する方法を学びます。この操作には、RedisのLTRIMコマンドを使用します。

LTRIMコマンドとは

LTRIMコマンドは、既存のリスト値を、指定した範囲の要素だけが残るように切り詰めるコマンドです。範囲はstart(開始位置・含む)とend(終了位置・含む)のオフセットによって定義され、リストのどの部分を残すかを決定します。

インデックスは0始まりです。つまり、0が最初の要素、1が2番目の要素というように数えます。また、負の数を使用すると、リストの末尾から数えたオフセットを指定できます。-1は最後の要素、-2は最後から2番目の要素を意味します。

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

1. start > end の場合: 結果は空のリストとなり、指定されたキーは削除されます。
2. end がリストのサイズより大きい場合: リストの最後の要素のインデックスがendオフセットとして扱われます。

なお、キーは存在するものの、そのキーに保存されている値がリスト型でない場合は、エラーが返されます。Redis LTRIMコマンドの構文は以下のとおりです。

構文

redis host:post> LTRIM <keyname> <start> <stop>

戻り値

- (string) OK
- エラー: キーが存在するが、保存されている値がリスト型ではない場合

使用例

例えば、キー「mylist」に「a、b、c、d、e」の5つの要素が保存されている場合、「LTRIM mylist 1 3」を実行すると、リストには2番目から4番目の要素である「b、c、d」のみが残ります。

参考資料

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

以上が、Redisデータストア内のキーに保存された既存のリスト値をトリミングする方法の解説でした。この記事が役に立ったら、ぜひコメント欄で感想を共有したり、他の方にもシェアしていただけると嬉しいです。