Updated on 2025-09-09 GMT+08:00

OpenSource ClickHouse Connection Parameters

Table 1 OpenSource ClickHouse connection

Parameter

Mandatory

Description

Data Connection Type

Yes

OpenSource ClickHouse is selected by default and cannot be changed.

Name

Yes

Name of the data connection to create. Data connection names can contain a maximum of 100 characters. They can contain only letters, digits, underscores (_), and hyphens (-).

Description

No

A description which can help identify the data connection more easily. It can contain a maximum of 100 characters.

Tag

No

Attribute of the data connection to create. Tags make management easier.
NOTE:

The tag name can contain only letters, digits, and underscores (_) and cannot start with an underscore (_) or contain more than 100 characters.

Applicable Modules

Yes

Select the modules for which this connection is available.

NOTE:
  • When offline or real-time data migration jobs are enabled, you can select the DataArts Migration module. Then you can select this data connection when creating a data migration job in DataArts Factory.
  • You can use offline or real-time data migration jobs only after you apply for the whitelist membership. To use this feature, contact customer service or technical support.

Basic and Network Connectivity Configuration

IP Address

Yes

IP address of the node where the ClickHouseServer is located

Port

Yes

Used to receive JDBC requests. By default, the value of the http_port parameter of ClickHouseServer is used.

KMS Key

Yes

KMS key used to encrypt and decrypt data source authentication information. Select a default or custom key.
NOTE:
  • When you use KMS for encryption through DataArts Studio or KPS for the first time, the default key dlf/default or kps/default is automatically generated. For more information about default keys, see What Is a Default Master Key?.
  • Only symmetric keys are supported. Asymmetric keys are not supported.

Agent

Yes

As a network proxy, the CDM cluster must be able to communicate with the ClickHouseServer. If no CDM cluster is available, create one first by referring to Creating a CDM Cluster.

NOTE:

If a CDM cluster functions as the agent for a data connection in Management Center, the cluster supports a maximum of 200 concurrent active threads. If multiple data connections share an agent, a maximum of 200 SQL, Shell, and Python scripts submitted through the connections can run concurrently. Excess tasks will be queued. You are advised to plan multiple agents based on the workload.

Data Migration Configuration

Database Name

Yes

Name of the database to connect

Example: dbname

Driver Version

No

ClickHouse driver version

  • CLICKHOUSE_0_3_1: This driver version is suitable for connecting to ClickHouse of versions earlier than 20.7. It cannot connect to the database server using multiple IP addresses.
  • CLICKHOUSE_0_4_2: This driver version is suitable for connecting to ClickHouse 20.7 and later versions. It can connect to the database server using multiple IP addresses.
    NOTE:
    • If you select CLICKHOUSE_0_4_2, the minimum timestamp allowed is 1970-01-01 08:00:00.
    • The CLICKHOUSE_0_4_2 driver supports only servers whose ClickHouse version is 20.7 or later.
    • If you select CLICKHOUSE_0_4_2, the field name cannot contain (). This limitation does not apply to other versions.

Reference Sign

No

Delimiter between the names of the referenced tables or columns. For details, see the product documentation of the corresponding database. The default value is ".

Commit Size

No

Number of rows submitted in a batch The default value is 10000.

Link Attributes

No

Attributes, including attribute names and values.

The followings are some examples:

1. socket_timeout: socket connection timeout duration, in milliseconds

2. connection_timeout: connection timeout duration, in milliseconds

3. dataTransferTimeout: data transfer timeout duration, in milliseconds

Data Source Authentication and Other Function Configuration

Username

Yes

ClickHouseServer username

Password

Yes

Password for accessing the ClickHouseServer