SCAN

Scan the database for keys.

Arguments

cursor · int · required

The cursor, use 0 in the beginning and then use the returned cursor for subsequent calls.

match · str · required

Glob-style pattern to filter by field names.

count · int · required

Number of fields to return per call.

type · str

Filter by type. For example string, hash, set, zset, list, stream.

Response

The new cursor and the keys as a tuple. If the new cursor is 0 the iteration is complete.

Use the new cursor for subsequent calls.

Example

# Get all keys

cursor = 0
results = []

while True:
    cursor, keys = redis.scan(cursor, match="*")

    results.extend(keys)
    if cursor == 0:
        break