redis-iterate-keys

Iterate over keys in Redis, using the SCAN command.

Installation

npm install redis-iterate-keys

Usage

const Redis = require('ioredis')
const iterateKeys = require('redis-iterate-keys')

const redis = new Redis()
for await (const key of iterateKeys(redis)) {
	console.log(key)
}
redis.quit()

iterateKeys(redisClient, opt = {})

You can pass the following options:

• opt.match: Match keys with a pattern, see the MATCH docs
• opt.batchSize: How many keys to retrieve in one SCAN call. Set it to a higher number for higher iteration speed. Default: 20

Related

• redis-scanrx – Rx interface to Redis SCAN.
• redis-skim – Callback interface to Redis SCAN.

Contributing

If you have a question or need support using redis-iterate-keys, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, use the issues page.