Redis-v1 连接器


Redis-v1 连接器

上级文档: Connectors

BitSail Redis连接器支持写 Redis 库,主要功能点如下:

  • 支持批式写入Redis
  • 支持写入多种格式

依赖引入

<dependency>
   <groupId>com.bytedance.bitsail</groupId>
   <artifactId>connector-redis</artifactId>
   <version>${revision}</version>
</dependency>

Redis写入

支持数据类型

目前支持以Redis中的String, Set, Hash, Sorted Set四种格式写入。 每种格式对要写入的数据的具体要求如下:

数据类型要求的列数第一列第二列第三列
String2keyvalue
Set2key要插入到Set中的value
Hash3keyhash中的keyhash中的value
Sorted Set (Zset)3keyscore要插入到Set中的value

主要参数

写连接器参数在job.writer中配置,实际使用时请注意路径前缀。示例:

"writer": {
      "class": "com.bytedance.bitsail.connector.redis.sink.RedisSink",
      "redis_data_type": "hash",
      "redis_host": "localhost",
      "redis_port": 6379,
      "columns": [
        {
          "index": 0,
          "type": "string"
        },
        {
          "index": 1,
          "type": "string"
        },
        {
          "index": 2,
          "type": "string"
        }
      ]
    }

必需参数

参数名称是否必填参数枚举值参数含义
classRedis写连接器类型, com.bytedance.bitsail.connector.legacy.redis.sink.RedisOutputFormat
redis_hostRedis连接地址
redis_portRedis连接端口
columns写入列数据字段,字段的类型可以是binarystring或者其他基本格式,binary类型指代的是byte[]格式。

可选参数

参数名称是否必填参数枚举值参数含义
writer_parallelism_num指定redis写并发
client_timeout_msRedis的连接/请求超时, 默认60000ms
ttl写入数据的ttl, 默认-1表示不设置
ttl_type"DAY", "HOUR", "MINUTE", "SECOND"上面指定的ttl单位, 默认"DAY"
write_batch_intervalRedis指令攒批写入的大小, 默认50
redis_data_type"string"
"set"
"hash"
"sorted_set"
"mhash"
写入Redis的数据格式, 默认 string
passwordRedis连接密码
connection_pool_max_total连接池最大可分配实例
connection_pool_max_idle连接池最大空闲实例
connection_pool_min_idle连接池最小空闲实例
connection_pool_max_wait_time_ms连接池最大等待时间
max_attempt_count重试器最大重试次数

相关文档

配置示例文档:Redis-v1 连接器示例