Create a ClickHouse Data Source
This guide describes how to add a ClickHouse data source in the NineData console. Available parameters, connection methods, and required fields depend on the creation form in the target environment.
Before you begin
The server IP address of NineData has been added to the data source allowlist. The server IP address can be viewed by selecting the target region in Access Region on the Create Datasource page.

Make sure data source quota is available; otherwise, the data source cannot be added. Check the remaining quota in the NineData Console header.

Procedure
Sign in to the NineData Console.
On the left navigation pane, click Datasource > Datasource.
- Select the Datasource tab, and then select Create Datasource. In the data source type selector, choose Database > (the type of data source to be added). On the Create Datasource page, configure the parameters based on the table below.tip
If you make a mistake during the operation, select the
icon at the top of the Create Datasource page and choose again.
Configure the data source parameters:
Parameter Control type Required and default Description Name Text input Required; no prefilled value Enter a name to identify this ClickHouse data source. Connection Radio group Required; IP Address is selected by default in the inspected form Options: IP Address, Gateway, and SSH Tunnel. Select the connection method for this data source. Gateway Dropdown Shown only for the Gateway connection branch; required; no preselected value Select an available gateway for the connection. Available choices depend on the organization configuration. Host Text input (target database address) Required; no prefilled value Enter the target ClickHouse host. This field appears in all three connection branches shown in the current form. Port Text input (target database port) Not marked required; the current SaaS creation form is prefilled with 8123Enter the target ClickHouse service port and confirm it matches the target instance. This target port field appears in every connection branch inspected. Port Text input (SSH connection port) Not marked required; no prefilled value Enter the SSH server port only when you select SSH Tunnel. DB Account Text input Not marked required; no prefilled value Enter the database account used to log in to ClickHouse. This field appears in all three connection branches shown in the current form. SSH Host Text input (SSH host) Required only in the SSH Tunnel branch; no prefilled value Enter the SSH tunnel server host. SSH Authentication Method Dropdown Required only in the SSH Tunnel branch; Password is selected by default Options: Password and Key. Select the SSH authentication method. SSH Username Text input (SSH username) Required in the SSH Tunnel authentication branch inspected; no prefilled value Enter the SSH server login username. Password Password input (SSH password) Required in the SSH Tunnel authentication branch inspected; no prefilled value Enter the SSH server login password. Key File File upload Required when Key authentication is selected in the SSH Tunnel branch; no file uploaded Upload the file used for SSH key authentication. Password Text input (passphrase) Optional when Key authentication is selected in the SSH Tunnel branch; no prefilled value Enter the key authentication passphrase when needed. DB Password Password input Not marked required; no prefilled value Enter the ClickHouse data source password. Access Region Dropdown Required; select an applicable region Select the access region. Environment Dropdown Required; the preselected value varies by target environment and organization Select the environment assigned to this data source. Available values depend on the target environment and organization configuration. SSL Switch Not marked required; off by default in the current form The current creation form provides this SSL encryption switch.