This topic describes how to add a ClickHouse data source in DataV and provides details about the parameter settings.
Prerequisites
A ClickHouse data source is prepared.
You must add the IP addresses for the corresponding region to the whitelist of your data source. This ensures that DataV can access your database. For more information, see Configure a database whitelist.
Add a data source over an internal network
Access the DataV console.
On the Workbench page, click . On the Data Source page, click New Data Source.
From the Type list, select ClickHouse.
From the list, select Internal Network and then select the region where your ClickHouse instance is located.
Select the network type of the internal database. The network type can be virtual private cloud (VPC) or classic network.
Virtual private cloud (VPC)
Turn on the VPC switch to enable VPC mode.
Enter the database configuration information.
Parameter
Description
Name
A custom name for the data source.
VPC ID
The ID of the VPC instance. This is the VPC where your ClickHouse instance resides. You can log on to the ApsaraDB for ClickHouse console, click the cluster ID, and find the VPC ID in the Network Information section on the Cluster Information page.
VPC Instance ID
You can use one of the following: the ID of the VPC-connected database instance, the VPC network endpoint, or the VPC IP address.
Domain Name
The VPC endpoint used to access the ClickHouse database instance. You can log on to the ApsaraDB for ClickHouse console, click the cluster ID, and find the VPC endpoint in the Network Information section on the Cluster Information page.
Port
The port number of the database.
Database Logon Information
Enter the username and password for the ClickHouse instance that you want to access. You can automatically retrieve the database list or enter a database name manually.
You can log on to the ApsaraDB for ClickHouse console, click the cluster ID, and view the account information on the Account Management page in the navigation pane on the left.
Classic network
Turn off the VPC switch to enable classic network mode.
Enter the database configuration information.
Parameter
Description
Name
A custom name for the data source.
Domain Name
The classic network endpoint used to access the ClickHouse database instance.
Port
The port number of the database.
Database Logon Information
Enter the username and password for the ClickHouse instance that you want to access. You can automatically retrieve the database list or enter a database name manually.
You can log on to the ApsaraDB for ClickHouse console, click the cluster ID, and view the account information on the Account Management page in the navigation pane on the left.
After you enter the database information, click OK. The system automatically tests the connection. If the test is successful, the new data source appears in the data source list.
Add a data source over the internet
Access the DataV console.
On the Workbench page, click . On the Data Source page, click New Data Source.
From the Type list, select ClickHouse.
From the list, select Internet.
Enter the database configuration information.
Parameter
Description
Name
A custom name for the data source.
Domain Name
The public endpoint used to access the ClickHouse database instance. You can log on to the ApsaraDB for ClickHouse console, click the cluster ID, and find the public endpoint in the Network Information section on the Cluster Information page.
Port
The port number of the database.
Database Logon Information
Enter the username and password for the ClickHouse instance that you want to access. You can automatically retrieve the database list or enter a database name manually.
You can log on to the ApsaraDB for ClickHouse console, click the cluster ID, and view the account information on the Account Management page in the navigation pane on the left.
After you enter the database information, click OK. The system automatically tests the connection. If the test is successful, the new data source appears in the data source list.
What to do next
After you obtain the raw data, see Configure a widget data source to adapt the data for your widgets.
FAQ
For more information, see FAQ about data source configuration and usage.