Команда Redis SCAN

Ключ (key) Redis

Команда Redis Scan используется для итерации ключей базы данных.

Команда SCAN является курсорным итератором, после каждого вызова которой она возвращает новый курсор. Пользователь должен использовать этот новый курсор в качестве параметра курсора команды SCAN в следующей итерации, чтобы продолжить предыдущую итерацию.

SCAN возвращает массив, содержащий два элемента: первый элемент - это новый курсор для следующей итерации, а второй элемент - это массив, который содержит все итерированные элементы. Если новый курсор возвращает 0, это означает, что итерация завершена.

Связанные команды:

• SSCAN Команда используется для итерации элементов ключа набора.
• HSCAN Команда используется для итерации пар ключ-значение хеш-ключа.
• ZSCAN Команда используется для итерации элементов有序ого набора (включая элемент члена и элемент оценки).

Грамматика

Основная грамматика команды redis Scan такова:

SCAN курсор [Совпадение шаблона] [КОЛИЧЕСТВО количество]

• cursor - Курсор.
• pattern - Мatching 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"

Ключ (key) Redis