Skip to main content
Version: 2.3.0-beta

Redis

Redis sink connector

Description​

Write Rows to a Redis.

tip

Engine Supported and plugin name

  • Spark: Redis
  • Flink

Options​

nametyperequireddefault value
hoststringno"localhost"
portintno6379
authstringno
db_numintno0
data_typestringno"KV"
hash_namestringno
list_namestringno
set_namestringno
zset_namestringno
timeoutintno2000
ttlintno0
is_self_achievedbooleannofalse

host [string]​

Redis server address, default "localhost"

port [int]​

Redis service port, default 6379

auth [string]​

Redis authentication password

db_num [int]​

Redis database index ID. It is connected to db 0 by default

redis_timeout [int]​

Redis timeout

data_type [string]​

Redis data type eg: KV HASH LIST SET ZSET

hash_name [string]​

if redis data type is HASH must config hash name

list_name [string]​

if redis data type is LIST must config list name

zset_name [string]​

if redis data type is ZSET must config zset name

set_name [string]​

if redis data type is SET must config set name

ttl [int]​

redis data expiration ttl, 0 means no expiration.

is_self_achieved [boolean]​

If a redis access by a self-achieved redis proxy, which is not support redis function of "info Replication"

Examples​

redis {
host = "localhost"
port = 6379
auth = "myPassword"
db_num = 1
data_type = "HASH"
hash_name = "test"
is_self_achieved = false
}