SCAN for safe key iteration in Redis - Mini Project: Build & Apply

Safe Key Iteration Using SCAN in Redis

📖 Scenario: You are managing a Redis database that stores user session data. You want to safely iterate over all keys without blocking the server or causing performance issues.

🎯 Goal: Build a Redis SCAN command sequence to safely iterate over all keys matching a pattern.

📋 What You'll Learn

Create a variable called cursor and set it to 0

Set a variable pattern to the string "session:*"

Use the Redis SCAN command with cursor and pattern to fetch keys

Update the cursor with the returned cursor from SCAN

Repeat the SCAN command until cursor returns to 0

💡 Why This Matters

🌍 Real World

Redis SCAN is used in real applications to safely iterate over large keyspaces without blocking the database.

💼 Career

Knowing how to use SCAN helps backend developers and database administrators manage Redis data efficiently and avoid performance issues.

1

Initialize the cursor for SCAN

Create a variable called cursor and set it to 0 to start scanning from the beginning.

Redis

# Your code here

Need a hint?

The cursor starts at 0 to begin scanning from the start of the keyspace.

2

Set the key pattern to scan

Create a variable called pattern and set it to the string "session:*" to match all session keys.

Redis

cursor = 0
# Your code here

Need a hint?

The pattern helps filter keys that start with 'session:'.

3

Perform one SCAN iteration

Use the Redis SCAN command with cursor and pattern to fetch keys. Assign the returned cursor to cursor and the keys to keys.

Redis

cursor = 0
pattern = "session:*"
# Your code here

Need a hint?

The SCAN command returns a new cursor and a list of keys matching the pattern.

4

Repeat SCAN until complete

Write a loop that repeats the SCAN command using cursor and pattern until cursor becomes 0, indicating the scan is complete.

Redis

cursor = 0
pattern = "session:*"
cursor, keys = redis_client.scan(cursor=cursor, match=pattern)
# Your code here

Need a hint?

The loop continues scanning until the cursor returns to 0, meaning all keys have been scanned.