Method: Redis#scan

Defined in:

lib/redis.rb

#scan(cursor, options = {}) ⇒ String⁺

Scan the keyspace

Examples:

Retrieve the first batch of keys

redis.scan(0)
  # => ["4", ["key:21", "key:47", "key:42"]]

Retrieve a batch of keys matching a pattern

redis.scan(4, :match => "key:1?")
  # => ["92", ["key:13", "key:18"]]

Parameters:

• cursor: (String, Integer) —

  the cursor of the iteration

• options (Hash) (defaults to: {}) —
  • :match => String: only return keys matching the pattern
  • :count => Integer: return count keys at most per iteration

Returns:

• (String, Array<String>) —

  the next cursor and all found keys

# File 'lib/redis.rb', line 2297

def scan(cursor, options={})
  _scan(:scan, cursor, [], options)
end