Skip to main content

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.

    server_ip_address

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

Procedure​

  1. Sign in to the NineData Console.

  2. On the left navigation pane, click Datasource > Datasource.

  3. 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 arrow_down icon at the top of the Create Datasource page and choose again.

  1. Configure the data source parameters:

    Parameter
    Control typeRequired and defaultDescription
    NameText inputRequired; no prefilled valueEnter a name to identify this ClickHouse data source.
    ConnectionRadio groupRequired; IP Address is selected by default in the inspected formOptions: IP Address, Gateway, and SSH Tunnel. Select the connection method for this data source.
    GatewayDropdownShown only for the Gateway connection branch; required; no preselected valueSelect an available gateway for the connection. Available choices depend on the organization configuration.
    HostText input (target database address)Required; no prefilled valueEnter the target ClickHouse host. This field appears in all three connection branches shown in the current form.
    PortText 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.
    PortText input (SSH connection port)Not marked required; no prefilled valueEnter the SSH server port only when you select SSH Tunnel.
    DB AccountText inputNot marked required; no prefilled valueEnter the database account used to log in to ClickHouse. This field appears in all three connection branches shown in the current form.
    SSH HostText input (SSH host)Required only in the SSH Tunnel branch; no prefilled valueEnter the SSH tunnel server host.
    SSH Authentication MethodDropdownRequired only in the SSH Tunnel branch; Password is selected by defaultOptions: Password and Key. Select the SSH authentication method.
    SSH UsernameText input (SSH username)Required in the SSH Tunnel authentication branch inspected; no prefilled valueEnter the SSH server login username.
    PasswordPassword input (SSH password)Required in the SSH Tunnel authentication branch inspected; no prefilled valueEnter the SSH server login password.
    Key FileFile uploadRequired when Key authentication is selected in the SSH Tunnel branch; no file uploadedUpload the file used for SSH key authentication.
    PasswordText input (passphrase)Optional when Key authentication is selected in the SSH Tunnel branch; no prefilled valueEnter the key authentication passphrase when needed.
    DB PasswordPassword inputNot marked required; no prefilled valueEnter the ClickHouse data source password.
    Access RegionDropdownRequired; select an applicable regionSelect the access region.
    EnvironmentDropdownRequired; the preselected value varies by target environment and organizationSelect the environment assigned to this data source. Available values depend on the target environment and organization configuration.
    SSLSwitchNot marked required; off by default in the current formThe current creation form provides this SSL encryption switch.