Redis SCAN コマンド

Redis key(キー)

Redis Scan コマンドはデータベース内のデータベースキーをイテレートするために使用されます。

SCAN コマンドはカーソルに基づくイテレータであり、呼び出されるたびにユーザーに新しいカーソルを返します。ユーザーは次のイテレーションでこの新しいカーソルを使用してSCAN コマンドのカーソルパラメータを指定し、前のイテレーションのプロセスを継続する必要があります。

SCAN は、2つの要素を含む配列を返します。1つ目の要素は、次の反復に使用する新しいカーソルであり、2つ目の要素は、すべての反復された要素を含む配列です。新しいカーソルが 0 で返された場合、反復は終了しました。

関連コマンド：

• SSCAN コマンドは、集合キーの要素を反復するために使用されます。
• HSCAN コマンドは、ハッシュキーのキー値対を反復するために使用されます。
• ZSCAN コマンドは、順序付き集合の要素（要素メンバーおよび要素値）を反復するために使用されます。

语法

redis Scan コマンドの基本的な语法は以下の通りです：

SCAN cursor [MATCH pattern] [COUNT count]

• cursor - カーソル。
• pattern - マッチするパターン。
• count - データセットから返す要素の数を指定します。デフォルト値は 10 。

利用可能なバージョン

>= 2.8.0

返り値

配列リスト。

オンラインサンプル

SCAN コマンドを使用して反復する：

redis 127.0.0.1:6379> scan 0   # カーソル 0 を使用して新しい反復を開始する
1) "17"                        # 最初の反復で返されたカーソル
2)  1) "key:12"
    2) "key:8"
    3) "key:4"
    4) "key:14"
    5) "key:16"
    6) "key:17"
    7) "key:15"
    8) "key:10"
    9) "key:3"
   10) "key:7"
   11) "key:1"
redis 127.0.0.1:6379> scan 17  # 使用しているのは最初の反復で返されたカーソル 17 新しい反復を開始する
1) "0"
2) 1) "key:5"
   2) "key:18"
   3) "key:0"
   4) "key:2"
   5) "key:19"
   6) "key:13"
   7) "key:6"
   8) "key:9"
   9) "key:11"

Redis key(キー)