【Redis入門】ZPOPMIN / BZPOPMINでソート済みセットの最小スコア要素を取り出す方法

このチュートリアルでは、Redisデータストアに保存されたソート済みセット（Sorted Set）から、最小スコアの要素を削除して取得する方法を、ZPOPMINおよびBZPOPMINコマンドを使って学習します。

ZPOPMINコマンドとは

ZPOPMINコマンドは、指定したキーに格納されたソート済みセットから、スコアが最も小さい要素を1つ以上削除し、その要素を返します。引数としてcount（削除する要素の総数）を指定できます。省略した場合のデフォルト値は1です。要素が返される際は、最小スコアの要素が最初に、その後にスコアの高い順に続きます。

キーは存在するものの、その値がソート済みセット型ではない場合はエラーが返されます。また、キーが存在しない場合はNil（null）が返されます。

構文

redis host:post> ZPOPMIN <keyname> <count>

戻り値

- (array) ソート済みセットの要素とスコアを表す配列
- (nil) キーが存在しない場合
- エラー キーは存在するが、値がソート済みセット型ではない場合

実行例

BZPOPMINコマンドとは

BZPOPMINコマンドは、ZPOPMINのブロッキング版です。指定されたすべてのソート済みセットからポップできる要素がない場合（すべてのセットが空であるか、すべてのキーが存在しない場合）、操作をブロックします。

キーは左から右へ順番にチェックされ、最初に見つかった空でないソート済みセットから、最小スコアの要素を削除して返します。たとえば、BZPOPMIN set1 set2 set3 0を実行した場合を考えてみましょう。set1が存在せず（空のセットとみなされる）、set2が空のセット、set3に3つの要素が含まれているとすると、左からチェックして最初の非空セットであるset3から、最小スコアの要素が削除・返されます。

このコマンドは引数としてtimeout（整数）を受け取ります。これはブロックする最大秒数を表し、0を指定すると無期限にブロックし続けます。

構文

redis host:post> BZPOPMIN <keyname> [ <keyname> ] <timeout>

戻り値

- (array) 3つの要素を持つ配列。1つ目はソート済みセットのキー名、
  2つ目はポップされた要素のスコア、3つ目はポップされた要素そのもの。
- (nil) 要素をポップできず、タイムアウトが経過した場合。

実行例

参考資料

1. ZPOPMINコマンド公式ドキュメント
2. BZPOPMINコマンド公式ドキュメント

以上が、Redisデータストア内のソート済みセットから最小スコアの要素を削除して取得する方法でした。この記事が役に立ったら、コメント欄で感想を共有したり、他の方にもシェアしてみてください。