Easy Tutorial
Sorted Sets Zrevrangebyscore Hashes Hget Hyperloglog Pfcount Strings Msetnx Redis Partitioning Connection Select Redis Geo Lists Lset Server Config Resetstat Sets Sismember Lists Brpop Strings Getbit Keys Randomkey Strings Setex Server Client Getname Pub Sub Punsubscribe Strings Incrby Sorted Sets Zincrby Keys Dump Sets Spop Strings Get Strings Psetex Lists Lrange Redis Sets Server Command Getkeys Strings Decr Strings Incr Redis Transactions Lists Lpop Sorted Sets Zrank Keys Pexpireat Scripting Script Load Sorted Sets Zunionstore Scripting Script Exists Hashes Hexists Keys Expireat Sets Sinterstore Keys Del Keys Move Sorted Sets Zscore Lists Llen Server Info Server Debug Object Sorted Sets Zremrangebylex Server Config Rewrite Sets Sdiffstore Pub Sub Subscribe Redis Keys Server Client Pause Strings Strlen Redis Backup Keys Ttl Sorted Sets Zrange Redis Strings Sets Sdiff Hashes Hmget Sorted Sets Zcard Connection Quit Strings Setrange Server Flushall Keys Renamenx Server Config Set Connection Ping Lists Brpoplpush Sets Sinter Server Flushdb Redis Intro Server Client List Keys Type Server Sync Keys Pexpire Sorted Sets Zremrangebyscore Keys Rename Java Environment Setup Transactions Discard Redis Lists Server Client Setname Server Role Hashes Hsetnx Redis Sorted Sets Keys Persist Transactions Watch Lists Ltrim Server Client Kill Strings Getset Sets Smove Lists Lpushx Sorted Sets Zscan Connection Echo Strings Mget Sorted Sets Zlexcount Redis Hyperloglog Sorted Sets Zadd Sets Srandmember Redis Pipelining Transactions Multi Hashes Hdel Hashes Hkeys Pub Sub Psubscribe Keys Exists Sorted Sets Zremrangebyrank Sorted Sets Zrevrange Lists Rpushx Server Debug Segfault Hashes Hvals Server Bgrewriteaof Sets Sscan Strings Mset Keys Pttl Connection Auth Strings Incrbyfloat Keys Expire Sorted Sets Zrangebylex Hashes Hmset Sets Scard Sorted Sets Zrevrank Strings Decrby Server Lastsave Server Cluster Slots Redis Commands Redis Install Server Save Server Config Get Redis Hashes Keys Keys Hashes Hincrbyfloat Redis Data Types Strings Setbit Redis Benchmarks Hyperloglog Pfmerge Sorted Sets Zrem Transactions Exec Server Command Info Pub Sub Unsubscribe Transactions Unwatch Strings Getrange Hashes Hincrby Sorted Sets Zrangebyscore Redis Pub Sub Sets Smembers Lists Lindex Scripting Eval Sets Sadd Hyperloglog Pfadd Lists Lrem Redis Tutorial Server Slowlog Lists Blpop Pub Sub Publish Lists Linsert Scripting Evalsha Sets Sunionstore Redis Conf Server Command Count Sorted Sets Zcount Server Monitor Sorted Sets Zinterstore Server Command Server Dbsize Hashes Hlen Scripting Script Flush Server Slaveof Keys Scan Redis Connection Hashes Hset Redis Server Redis Scripting Lists Rpop Redis Client Connection Scripting Script Kill Redis Security Server Time Strings Append Redis Java Server Showlog Server Shutdown Lists Rpush Lists Rpoplpush Lists Lpush Server Bgsave Sets Srem Strings Setnx Redis Stream Hashes Hscan Redis Php Pub Sub Pubsub Hashes Hgetall Strings Set Sets Sunion
❮ Server Slaveof Redis Connection ❯

Redis SCAN Command

Redis Keys

The Redis SCAN command is used to iterate over the database keys in the database.

The SCAN command is a cursor-based iterator, which returns a new cursor to the user after each call. The user needs to use this new cursor as the cursor parameter for the next SCAN command to continue the iteration process.

SCAN returns an array containing two elements: the first element is the new cursor for the next iteration, and the second element is an array containing all the iterated elements. If the new cursor returns 0, it indicates that the iteration has ended.

Related commands:

Syntax

The basic syntax of the Redis SCAN command is as follows:

SCAN cursor [MATCH pattern] [COUNT count]

Available Versions

= 2.8.0

Return Value

Array list.

Example

redis 127.0.0.1:6379> scan 0   # Start a new iteration with 0 as the cursor
1) "17"                        # The cursor returned during the first iteration
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  # Start a new iteration with the cursor 17 returned from the first iteration
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 Keys

❮ Server Slaveof Redis Connection ❯