Key In Redis filter plugin for Embulk

Filtering by aggregated the keys in included Redis's SET.

This plugin is designed to extract data set diff files used with the combination in below use cases.

  1. Use this plugin and output specified key's to redis.
  2. Input another data source and use filter key_in_redis plugin with specified key's then filtered the key's (or that hash).
    • this plugin

Overview

  • Plugin type: output
  • Load all or nothing: no
  • Resume supported: no
  • Cleanup supported: no

Configuration

name type required? default description
host string optional "127.0.0.1" redis servers host
port integer optional "6379" redis servers port
db integer optional "null" redis servers db
redis_set_key string required redis of key of set name
load_on_memory boolean optional "false" load all data from redis *1
appender string optional "-" multi key of appender
match_as_md5 boolean optional "false" smembers the value to converted md5
replica_hosts hash: Map optional list of replica redis servers host: port
key_with_index hash: Map required with key_with_index or json_key_with_index or only one index with key name
json_key_with_index hash: Map required with key_with_index or json_key_with_index or only one json columns's expanded key name
default_timezone string optional UTC
default_timestamp_format string optional %Y-%m-%d %H:%M:%S.%6N

*1: load_on_memory mode requires JVM memory as all records stored on Redis.

Example

  • inside redis

    sadd redis_key "ABC_1502590079312009_user_id_12345"

  • input json

    {  
"device_id":"ABC",
"timestamp_micros":1502590079312009,
"params":{  
  "UserID":"user_id_12345"
}
}

  • definition's yaml

    filters:
- type: expand_json
json_column_name: record
root: "$."
stop_on_invalid_record: false
expanded_columns:
  - { name: "device_id", type: string }
  - { name: "timestamp_micros", type: long }
  - { name: "params", type: json }
- type: "key_in_redis"
redis_set_key: redis_key
match_as_md5: false
key_with_index: 
  1: "device_id"
  2: "timestamp_micros"
json_key_with_index:
  3: "UserID" 
out:
type: "stdout"

  • filter as redis command

    smembers redis_key "ABC_1502590079312009_user_id_12345"

  • output None output causes aggregated key is inside in the redis.

Build

$ ./gradlew gem  # -t to watch change of files and rebuild continuously