Skip to content

Redis Reader

Redis Reader plugin is used to read Redis RDB data.

Configuration Example

json
{
  "job": {
    "setting": {
      "speed": {
        "channel": 1
      }
    },
    "content": {
      "reader": {
        "name": "redisreader",
        "parameter": {
          "connection": {
            "uri": ["tcp://127.0.0.1:6379", "file:///data/dump.rdb", "http://localhost/dump.rdb"],
            "auth": "password"
          },
          "include": [
            "^user"
          ],
          "exclude": [
            "^password"
          ],
          "db": [
            0,
            1
          ]
        }
      },
      "writer": {
        "name": "rediswriter",
        "parameter": {
          "connection": {
            "uri": "tcp://127.0.0.1:6379",
            "auth": "123456"
          },
          "timeout": 60000
        }
      }
    }
  }
}

Parameters

ConfigurationRequiredDefault ValueDescription
uriYesNoRedis connection, supports multiple local rdb files/network rdb files, if cluster, fill in all master node addresses
dbNoNoneDatabase index to read, if not filled, read all databases
includeNoNoneKeys to include, supports regular expressions
excludeNoNoneKeys to exclude, supports regular expressions

Constraints

  1. Does not support directly reading any redis server that does not support the sync command. If needed, please read from backed up rdb files.
  2. If it's a native redis cluster, please fill in all master node TCP addresses. The redisreader plugin will automatically dump rdb files from all nodes.
  3. Only parses String data type, other composite types (Sets, List, etc. will be ignored)