DataSail 中的 ClickHouse 数据源，为您提供读取和写入 ClickHouse 的双向通道数据集成能力，实现不同数据源与 ClickHouse 之间进行数据传输。
本文为您介绍 DataSail 的 ClickHouse 数据同步的能力支持情况。

1 支持的 ClickHouse 版本

支持 ClickHouse 20.X 以上自建开源版本。

2 使用限制

1. 子账号新建数据源时，需要有项目的管理员角色，方可以进行新建数据源操作。各角色对应权限说明，详见：管理成员。
2. 目前支持离线读取和离线写入 ClickHouse 场景。

3 支持的字段类型

4 数据同步任务开发

下文将为您介绍数据集成任务配置的详细流程。

4.1 数据源注册

新建数据源操作详见配置数据源，下面为您介绍通过连接串形式配置 ClickHouse 数据源：

4.2 新建离线任务

ClickHouse 数据源测试连通性成功后，进入到数据开发界面，开始新建 ClickHouse 相关通道任务。
新建任务方式详见离线数据同步。

4.3 可视化配置说明

任务创建成功后，您可根据实际场景，配置 ClickHouse 离线读或 ClickHouse 离线写等通道任务。

4.3.1 ClickHouse 离线读

数据来源选择 ClickHouse，并完成以下相关参数配置：
其中参数名称前带 * 的为必填参数，名称前未带 * 的为可选填参数。

4.3.2 ClickHouse 离线写

数据来源选择 ClickHouse，并完成以下相关参数配置：
其中参数名称前带 * 的为必填参数，名称前未带 * 的为可选填参数。

4.3.3 字段映射

数据来源和目标端配置完成后，需要指定来源和目标端的字段映射关系，根据字段映射关系，数据集成任务将源端字段中的数据，写入到目标端对应字段中。
字段映射支持选择基础模式和转换模式配置映射：

• 转换模式：
  字段映射支持数据转换，您可根据实际业务需求进行配置，将源端采集的数据，事先通过数据转换后，以指定格式输入到目标端数据库中。
  转换模式详细操作说明详见4.1 转换模式
  在转换模式中，你可依次配置：来源节点、数据转换、目标节点信息：

  配置节点	说明
  来源节点	配置数据来源 Source 节点信息： 节点名称：自定义输入来源节点名称信息，只允许由数字、字母、下划线、-和.组成；且长度不能超过10。 数据字段：通过自动添加、手动添加等方式添加数据来源字段信息。 配置完成后，单击确认按钮，完成来源节点配置。
  数据转换	单击数据转换右侧添加按钮，选择 SQL 转换方式，配置转换信息和规则： 节点名称：自定义输入来源节点名称信息，只允许由数字、字母、下划线、-和.组成；且长度不能超过10。 SQL 脚本：输入 SQL 脚本转换规则，目前仅支持添加一个转换的 SQL 语句，且不能包括 “;”。 配置完成后，单击确认按钮，完成数据转换节点配置。SQL 脚本示例详见4.1.2 添加转换节点。
  目标节点	配置目标节点 Sink 信息： 节点名称：自定义输入来源节点名称信息，只允许由数字、字母、下划线、-和.组成；且长度不能超过10。 数据字段：通过自动添加、手动添加等方式添加数据目标字段信息。 配置完成后，单击确认按钮，完成目标节点配置。

• 基础模式：

  您可通过以下三种方式操作字段映射关系：

  • 自动添加：单击自动添加按钮，根据两端数据表信息，可以自动填充来源和目标的字段信息。

    说明

    自动添加字段映射时，默认不会映射来源表中的分区键字段。若有需要，您可通过手动添加的方式，将分区键字段的映射配置上。

  • 手动添加：单击手动添加按钮，可以手动编辑来源和目标的字段信息，可以逐个添加。

    说明

    来源端字段信息支持输入数据库函数和常量配置，单击手动添加按钮，在源表字段中输入需添加的值，并选择函数或常量类型，例如：

    • 函数：支持您输入 now()、current_timestamp() 等 ClickHouse 数据库支持的函数。
    • 常量：您可自定义输入常量值，'123'、'${DATE}'、'${hour}' 等，输入值两侧需要加上英文单引号，支持结合时间变量参数使用。
  • 移动\删除字段：您也可以根据需要移动字段映射顺序或删除字段。

4.4 DSL 配置说明

ClickHouse 数据源支持使用脚本模式（DSL）的方式进行配置。
在某些复杂场景下，或当数据源类型暂不支持可视化配置时，您可通过任务脚本的方式，按照统一的 Json 格式，编写 ClickHouse Reader 和 ClickHouse Writer 参数脚本代码，来运行数据集成任务。

4.4.1 进入 DSL 模式

进入 DSL 模式操作流程，可详见 MySQL 数据源-4.4.1 进入DSL 模式。

4.4.2 ClickHouse 批式读

进入 DSL 模式编辑界面后，您可根据实际情况替换相应参数，ClickHouse 批示读脚本示例如下：

{
    // [required] dsl version, suggest to use latest version
    "version": "0.2",
    // [required] exection mode, supoort streaming / batch now
    "type": "batch",
    // reader config
    "reader": {
        // [required] datasource type
        "type": "clickhouse" ,
        // [optional] datasource id, set it if you have registered datasource
        "datasource_id": null,
        // [required] user parameter
        "parameter": {
            "split_field":"split_field_sample",   
            "password":"password_sample",  
            "db_name":"db_name_sample",   
            "user_name":"user_name_sample",
            "class":"com.bytedance.bitsail.connector.clickhouse.source.ClickhouseSource",
            "jdbc_url":"jdbc:clickhouse://{host}:{port}",
            "table_name":"table_name_sample",
            "columns": [
                {
                    "name": "name_sample",
                    "type": "type_sample"
                }
            ]
        }
    },
    // writer config
    "writer": {
        ...
    },
    // common config
    "common": {
        ...
    }
}

Reader 参数说明，其中参数名称前带 * 的为必填参数，名称前未带 * 的为可选填参数：

4.4.3 ClickHouse 批式写

根据实际情况替换 ClickHouse Writer 相应参数，ClickHouse 批式写脚本示例如下：

{
    // [required] dsl version, suggest to use latest version
    "version": "0.2",
    // [required] exection mode, supoort streaming / batch now
    "type": "batch",
    // reader config
    "reader": {
        ...
    },
    // writer config
    "writer": {
        // [required] datasource type
        "type": "clickhouse",
        // [optional] datasource id, set it if you have registered datasource
        "datasource_id": null,
        // [required] user parameter
        "parameter": {
            "user_name":"user_name_sample",
            "columns":[
                {
                    "name": "name_sample",
                    "type": "type_sample"
                }
            ],
            "table_name":"table_name_sample",
            "write_mode":"directlyInsert",
            "password":"password_sample",
            "db_name":"db_name_sample",
            "pre_sql_list":[    
                "pre_sql_sample"
            ],
            "post_sql_list":[    
                "post_sql_list"
            ],
            "class":"com.bytedance.dts.batch.jdbc.JDBCClickhouseOutputFormat",
            "connections":[
                {
                    "port":"port_sample",
                    "db_url":"jdbc:clickhouse://{host}:{port}/{db_name}?autoReconnect=true&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull",
                    "host":"host_sample"
                }
            ]
        }
    },
    // common config
    "common": {
        ...
    }
}

Writer 参数说明，其中参数名称前带 * 的为必填参数，名称前未带 * 的为可选填参数：

4.4.4 ClickHouse 流式写

根据实际情况替换 ClickHouse 相应参数，ClickHouse 流式写脚本示例如下：

{
    // [required] dsl version, suggest to use latest version
    "version": "0.2",
    // [required] exection mode, supoort streaming / batch now
    "type": "streaming",
    // reader config
    "reader": {
        ...
    },
    // writer config
    "writer": {
        // [required] datasource type
        "type": "clickhouse",
        // [optional] datasource id, set it if you have registered datasource
        "datasource_id": 9823,
        // [required] user parameter
        "parameter": {
            "user_name":"user_name_sample",
            "columns":[
                {
                    "name": "name_sample",
                    "type": "type_sample"
                }
            ],
            "table_name":"table_name_sample",
            "write_mode":"directlyInsert",
            "password":"password_sample",
            "db_name":"db_name_sample",
            "pre_sql_list":[    
                "pre_sql_sample"
            ]
            "format.type": "json",
            "class":"com.bytedance.dts.batch.jdbc.JDBCClickhouseOutputFormat",
            "connections":[
                {
                    "port":"port_sample",
                    "db_url":"jdbc:clickhouse://{host}:{port}/{db_name}?autoReconnect=true&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull",
                    "host":"host_sample"
                }
            ]
        }
    },
    // common config
    "common": {
        ...
    }
}

Writer 参数说明，其中参数名称前带 * 的为必填参数，名称前未带 * 的为可选填参数：