Skip to main content

Using Gateway to Connect ClickHouse Data Source

NineData supports connecting to ClickHouse data sources through a gateway. You do not need to provide a public IP address to connect to ClickHouse data sources within a private or dedicated network.

Prerequisites​

  • The host where the gateway is deployed must be in the intranet environment of the ClickHouse data source host and can access the ClickHouse data source through the intranet.
  • The host where the gateway is deployed must be able to access the public network. If your host cannot access the public network and is in the local area network, you can deploy it through a proxy gateway. For more information, see Using Proxy Gateway.

Step 1: Deploy Gateway​

This step is applicable to hosts that can access the public network. If your host cannot access the public network and is in the local area network, see Using Proxy Gateway to deploy the gateway.

  1. Log in to the NineData console on the host where the gateway needs to be deployed.

  2. In the left navigation pane, click >.

  3. Click in the upper right corner of the page.

  4. Configure the parameters based on the following table.

    ParameterDescription
    The name of the gateway. For easy searching and management, manual specification is supported.
    Select the operating system of the host where the gateway needs to be deployed, and the corresponding gateway installation method is displayed. The following operating systems are supported:
    • Windows(x86_64)
    • Linux(x86_64)
    • macOS
    Select the region closest to the host where the gateway is deployed to obtain relatively fast access speed.
    No configuration required.

  5. Install and configure the gateway on the host of the deployment end based on the installation method displayed below. After the configuration is completed, the connection diagram on the right side of the page changes from to .

  6. Click on , select the desired data source in the pop-up window, and proceed to Step 2.

Step 2: Connect to ClickHouse data source​

  1. On the page, configure the parameters according to the table below.

    Parameter
    		Description
    Enter the name of the data source. For convenience in future lookup and management, use a meaningful name whenever possible.
    Select .
    Select the gateway ID deployed in Step 1.
    Enter the access address and port of the ClickHouse data source.
    • If ClickHouse is installed on the local machine: enter localhost or 127.0.0.1 on the left and the actual port of ClickHouse on the right.
    • If ClickHouse is installed on another host on the intranet: enter the intranet IP of that host on the left and the actual port of ClickHouse on the right.
    Enter the login username for ClickHouse.
    Enter the login password for ClickHouse.
    Select the region closest to where your ClickHouse host is located to effectively reduce network latency.
    Select according to the actual business purpose of the data source as an environment identifier for the data source. The default provides the and environments, and also supports you to create a custom environment.
    Note: In organization mode, the database environment can also be applied to permission policy management. For example, the default role only supports access to data sources in the environment and cannot access data sources in other environments. For more information, see Managing Roles.

  2. After all configurations are completed, click on the right of to test if the data source can be accessed normally. If is prompted, click to complete the addition of the data source. Otherwise, please check the connection settings again until the connection test is successful.

Appendix: Using Proxy Gateway​

If the host where the gateway needs to be deployed cannot access the public network, a proxy gateway is needed. You need to prepare two hosts in the same LAN that can access each other:

  • Host A: A host that can access the public network.
  • Host B: The host where the gateway needs to be deployed.

Create a gateway in Host A. The role of this gateway is to act as a proxy so that Host B can connect to the NineData server through the proxy.

Procedure

  1. Log in to the NineData console on Host A.

  2. In the left navigation bar, click > .

  3. Click in the upper right corner of the page.

  4. Configure the parameters according to the following table.

    ParameterDescription
    The name of the gateway, which can be manually specified for easy search and management.
    Select the operating system of the host where the gateway needs to be deployed, and the corresponding gateway installation method will be displayed. The following operating systems are supported:
    • Windows (x86_64)
    • Linux (x86_64)
    • macOS
    Select the region closest to the host where the gateway is deployed to obtain relatively fast access speed.
    No need to configure.

  5. Install and configure the gateway in Host A according to the installation method displayed below. After the configuration is completed, the connection diagram on the right side of the page will change from to .

  6. Click , and then click in the upper right corner of the page again.

  7. In , select the operating system of Host B.

  8. Click , select , and click the drop-down box below . Select the gateway created in Host A from the drop-down menu.

    tip

    At this point, the gateway process will automatically open a port on Host A for Host B's access. When the page prompts "xxx has enabled proxy function, port xxx", it means that the proxy gateway has been successfully opened.

  9. Install the gateway on Host B according to the installation steps displayed below.

  10. Wait for the connection diagram on the right side of the page to change from to .

  11. Click to enter Step 2.

Last updated on