Updated on 2025-08-05 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 (-).

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.

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.