Clickhouse Sink

一、介绍

clickhouse sink

二、支持版本

ClickHouse 19.x及以上

三、插件名称

SYNC	clickhousesink, clickhousewriter
SQL	clickhouse-x

四、参数说明

1、sync

• connection
  • 描述：数据库连接参数，包含jdbcUrl、schema、table参数
  • 必选：是
  • 字段类型：List
  • 默认值：无
    • 示例：指定jdbcUrl、schema、table

"connection": [{
     "jdbcUrl": ["jdbc:clickhouse://localhost:8123/default"],
     "schema": "public",
     "table": ["table"]
    }]

​

• jdbcUrl
  • 描述：clickhouse jdbc url，详情参考clickhouse-jdbc官方文档
  • 必选：是
  • 字段类型：List
  • 默认值：无

• schema

  • 描述：数据库schema名
  • 必选：是
  • 字段类型：String
  • 默认值：无 ​
    

• table

  • 描述：目的表的表名称。目前只支持配置单个表，后续会支持多表
  • 必选：是
  • 字段类型：List
  • 默认值：无

​

• username
  • 描述：数据源的用户名
  • 必选：是
  • 字段类型：String
  • 默认值：无

​

• password
  • 描述：数据源指定用户名的密码
  • 必选：是
  • 字段类型：String
  • 默认值：无

​

• column
  • 描述：目的表需要写入数据的字段,字段之间用英文逗号分隔。例如: "column": ["id","name","age"]
  • 必选：是
  • 字段类型：List
  • 默认值：无

​

• fullcolumn
  • 描述：目的表中的所有字段，字段之间用英文逗号分隔。例如: "column": ["id","name","age","hobby"]，如果不配置，将在系统表中获取
  • 必选：否
  • 字段类型：List
  • 默认值：无

​

• preSql
  • 描述：写入数据到目的表前，会先执行这里的一组标准语句
  • 必选：否
  • 字段类型：List
  • 默认值：无

​

• postSql
  • 描述：写入数据到目的表后，会执行这里的一组标准语句
  • 必选：否
  • 字段类型：List
  • 默认值：无

​

• writeMode
  • 描述：控制写入数据到目标表采用 insert into 或者 replace into 或者 ON DUPLICATE KEY UPDATE 语句
  • 必选：否
  • 所有选项：insert
  • 字段类型：String
  • 默认值：insert

​

• batchSize
  • 描述：一次性批量提交的记录数大小，该值可以极大减少FlinkX与数据库的网络交互次数，并提升整体吞吐量。但是该值设置过大可能会造成FlinkX运行进程OOM情况
  • 必选：否
  • 字段类型：int
  • 默认值：1024

​

• semantic
  • 描述：sink端是否支持二阶段提交
  • 注意：
    • 如果此参数为空，默认不开启二阶段提交，即sink端不支持exactly_once语义；
    • 当前只支持exactly-once 和at-least-once
  • 必选：否
  • 参数类型：String
    • 示例："semantic": "exactly-once"
  • 默认值：at-least-once
    

2、sql

• connector
  • 描述：clickhouse-x
  • 必选：是
  • 字段类型：String
  • 默认值：无

​

• url
  • 描述：clickhouse jdbc url
  • 必选：是
  • 字段类型：String
  • 默认值：无

​

• schema

  • 描述：数据库schema名
  • 必选：否
  • 参数类型：string
  • 默认值：无
    

• table-name

  • 描述：表名
  • 必选：是
  • 字段类型：String
  • 默认值：无

​

• username
  • 描述：用户名
  • 必选：是
  • 字段类型：String
  • 默认值：无

​

• password
  • 描述：密码
  • 必选：是
  • 字段类型：String
  • 默认值：无

​

• password
  • 描述：密码
  • 必选：是
  • 字段类型：String
  • 默认值：无

​

• sink.buffer-flush.max-rows
  • 描述：批量写数据条数，单位：条
  • 必选：否
  • 字段类型：String
  • 默认值：1024

​

• sink.buffer-flush.interval
  • 描述：批量写时间间隔，单位：毫秒
  • 必选：否
  • 字段类型：String
  • 默认值：10000

​

• sink.all-replace
  • 描述：是否全部替换数据库中的数据(如果数据库中原值不为null,新值为null,如果为true则会替换为null)
  • 必选：否
  • 字段类型：String
  • 默认值：false

​

• sink.semantic

  • 描述：sink端是否支持二阶段提交
  • 注意：
    • 如果此参数为空，默认不开启二阶段提交，即sink端不支持exactly_once语义；
    • 当前只支持exactly-once 和at-least-once
  • 必选：否
  • 参数类型：String
    • 示例："semantic": "exactly-once"
  • 默认值：at-least-once
    

• sink.parallelism

  • 描述：写入结果的并行度
  • 必选：否
  • 字段类型：String
  • 默认值：无

五、数据类型

是否支持	数据类型
支持	BOOLEAN、TINYINT、SMALLINT、INT、BIGINT、FLOAT、DOUBLE、DECIMAL、STRING、VARCHAR、TIMESTAMP、DATE、BINARY、NULL
不支持	ARRAY、MAP、STRUCT、UNION

六、配置示例

见项目内flinkx-examples文件夹。