支持的版本

• 支持阿里云ClickHouse的20.8、21.8内核版本。
• 您需要确认驱动和您的ClickHouse服务之间的兼容能力，数据库驱动使用如下版本。

  <dependency>
      <groupId>ru.yandex.clickhouse</groupId>
      <artifactId>clickhouse-jdbc</artifactId>
      <version>0.2.4</version>
  </dependency>

使用限制

离线读写

• 仅支持使用 独享数据集成资源组 。
• 支持使用JDBC连接ClickHouse，且仅支持使用JDBC Statement读取数据。
• 支持筛选部分列、列换序等功能，您可以自行填写列。
• 考虑到ClickHouse负载问题，ClickHouse Writer使用INSERT模式时，建议您限流系统吞吐量（TPS）最高为1,000。

支持的字段类型

数据同步任务开发

ClickHouse数据同步任务的配置入口和通用配置流程指导可参见下文的配置指导，详细的配置参数解释可在配置界面查看对应参数的文案提示。

创建数据源

在进行数据同步任务开发时，您需要在DataWorks上创建一个对应的数据源，操作流程请参见 创建与管理数据源 。

单表离线同步任务配置指导

• 操作流程请参见 通过向导模式配置离线同步任务 、 通过脚本模式配置离线同步任务 。
• 脚本模式配置的全量参数和脚本Demo请参见下文的 附录：脚本Demo与参数说明 。

整库离线读同步配置指导

操作流程请参见 数据集成侧同步任务配置 。

附录：脚本Demo与参数说明

附录：离线任务脚本配置方式

如果您配置离线任务时使用脚本模式的方式进行配置，您需要在任务脚本中按照脚本的统一格式要求编写脚本中的reader参数和writer参数，脚本模式的统一要求请参见 通过脚本模式配置离线同步任务 ，以下为您介绍脚本模式下的数据源的Reader参数和Writer参数的指导详情。

ClickHouse Reader脚本Demo

{
    "type": "job",
    "version": "2.0",
    "steps": [
            "stepType": "clickhouse", //插件名。
            "parameter": {
                "fetchSize":1024,//该配置项定义了插件和数据库服务器端每次批量数据获取条数。
                "datasource": "example",
                "column": [   //列名。
                    "id",
                    "name"
                "where": "",    //过滤条件。
                "splitPk": "",  //切分键。
                "table": ""    //表名。
            "name": "Reader",
            "category": "reader"
            "stepType": "clickhouse",
            "parameter": {
                "postSql": [
                    "update @table set db_modify_time = now() where db_id = 1"
                "datasource": "example",    //数据源。
                "batchByteSize": "67108864",
                "column": [
                    "id",
                    "name"
                "writeMode": "insert",
                "encoding": "UTF-8",
                "batchSize": 1024,
                "table": "ClickHouse_table",
                "preSql": [
                    "delete from @table where db_id = -1"
            "name": "Writer",
            "category": "writer"
    "setting": {
        "executeMode": null,
        "errorLimit": {
            "record": "0"  //同步过程中的错误记录限流数。
        "speed": {
         "throttle":true,//当throttle值为false时，mbps参数不生效，表示不限流；当throttle值为true时,表示限流。
            "concurrent":1 //作业并发数。
            "mbps":"12",//限流
    "order": {
        "hops": [
                "from": "Reader",
                "to": "Writer"
}

ClickHouse Reader脚本参数

ClickHouse writer脚本Demo

{
    "type":"job",
    "version":"2.0",//版本号。
    "steps":[
            "stepType":"stream",
            "parameter":{},
            "name":"Reader",
            "category":"reader"
            "stepType":"clickhouse",//插件名。
            "parameter":{
                "username": "",
                "password": "",
                "column": [//字段。
                    "id",
                    "name"
                "connection": [
                        "table": [//表名。
                            "ClickHouse_table"
                        "jdbcUrl": "jdbc:clickhouse://ip:port/database"
                "preSql": [ //执行数据同步任务之前率先执行的SQL语句。
                    "TRUNCATE TABLE IF EXISTS tablename"
                "postSql": [//执行数据同步任务之后率先执行的SQL语句。
                    "ALTER TABLE tablename UPDATE col1=1 WHERE col2=2"
                "batchSize": "1024",
                "batchByteSize": "67108864",
                "writeMode": "insert"
            "name":"Writer",
            "category":"writer"
    "setting":{
        "errorLimit":{
            "record":"0"//错误记录数。
        "speed":{
            "throttle":true,//当throttle值为false时，mbps参数不生效，表示不限流；当throttle值为true时,表示限流。
            "concurrent":1, //作业并发数。
            "mbps":"12"//限流
    "order":{
        "hops":[
                "from":"Reader",
                "to":"Writer"
}

ClickHouse Writer脚本参数