Add a ClickHouse data source

Prerequisites

You have an available ClickHouse data source.

Add a data source over a private network

1. Log on to the DataV console.

2. On the My Data tab, select Data Source Management and click Add Data Source.

3. From the Type list, select ClickHouse.

4. Select Private Network and the region where your ClickHouse instance is located.

5. Enter the database information.

   Parameter	Description
   Name	The display name of the data source. You can enter a custom name.
   VPC ID	The ID of the VPC where your ClickHouse instance is located. To get this ID, go to the ApsaraDB for ClickHouse console and find the ID under Cluster List>Basic Information>Network Type.
   VPC Instance ID	The ID of the database instance in the VPC. You can get this from the instance's basic information page in the ApsaraDB for ClickHouse console. Note You can usually find the VPC instance ID of a database instance in its console. However, because of how VPC networks are implemented, the instance ID shown in the console may not be the one that DataV needs for VPC network configuration. Therefore, you must use the product's OpenAPI to get the correct VPC instance ID for DataV. This is usually the VPCCloudInstanceId or VPCInstanceId in the database instance details. To get the VPC instance ID, use the View cluster properties API operation.
   Domain Name	The address used to connect to the database. Important This address is a domain name or IP address that the DataV server can use to access your database over the public network or the private network in some Alibaba Cloud regions. For example, if you use an Alibaba Cloud ClickHouse instance in a private network environment, the domain name is similar to `rm-bpxxxxxxxxx33150.clickhouse.aliyuncs.com`. You can get this from the instance's basic information page in the ApsaraDB for ClickHouse console.
   Port	The port set for the database. The default is 8123.
   Username	The username to log on to the database.
   Password	The password to log on to the database.
   Database	The name of the database.

   After you enter the database information, the system automatically tests the connection to verify that the database is accessible.

   Important

   If the connection test fails with the error message Access VPC instance fail, add the -1 suffix to the Instance ID and test the connection again.

6. After the connection test is successful, click OK to add the data source.

   The new data source is automatically added to the data source list.

Add a data source over the internet

1. Log on to the DataV console.

2. On the My Data tab, select Data Source Management and click Add Data Source.

3. In the Type list, select ClickHouse.

4. Set Network to Internet and enter the database information.

   Parameter	Description
   Name	The display name of the data source. You can enter a custom name.
   Network	The available network types for the data source.
   Domain Name	The address used to connect to the database. Important This address is a domain name or IP address that the DataV server can use to access your database over the public network or the private network in some Alibaba Cloud regions.
   Port	The port set for the database.
   Username	The username to log on to the database.
   Password	The password to log on to the database.
   Database	Click Get Data List to retrieve all data lists from the currently selected database.

   After you enter the database information, the system automatically tests the connection to verify that the database is accessible.

   Important

   If the connection test fails with the error message Access VPC instance fail, add the -mysql, -instance, or -controller suffix to the Instance ID and test the connection again.

5. After the connection test is successful, click OK to add the data source.

   The new data source is automatically added to the data source list.