After you add a ClickHouse data source to connect the ClickHouse database to Quick BI, you can analyze and view data in the Quick BI console. Quick BI can access ClickHouse over the Internet or a virtual private cloud (VPC). This topic describes how to add a user-created ClickHouse data source in a group workspace.
Prerequisites
Your network meets the following requirements:
If you Quick BI connect to the ClickHouse database over the Internet, add the Quick BI IP address to the whitelist of the database. For more information, see Add security group rules.
If you use an internal network to connect Quick BI to the ClickHouse database, make sure that one of the following methods is used to ensure the connectivity between Quick BI and the user-created ClickHouse data source:
If the ClickHouse database is deployed on an Elastic Compute Service (ECS) instance, you can use a VPC to access the data source.
You can deploy a jump server and access the database over an SSH tunnel.
The username and password of the user-created ClickHouse database are obtained.
Limits
Only workspace administrators and organization administrators can add data sources.
Only Quick BI Pro and Pro editions support ClickHouse data sources.
Supports 20.3 and 22.8 versions.
Procedure
Log on to the Quick BI console.
Perform the steps that are shown in the following figure to add a Hologres data source.
Go to the Create Data Source page.
Select ClickHouse Data Source.
Select User-created Data Source Type.
In the Configure Connection dialog box, configure the following parameters based on your business scenario.
Feature
Description
Name
The name of the data source. The name is displayed in the data source list. The name cannot contain special characters or start or end with spaces.
Database address
The address where the ClickHouse database is deployed, including the IP address or domain name.
Port Number
The endpoint and port of the ApsaraDB for ClickHouse database.
Instance
The name of the ClickHouse database that is customized when you deploy the database.
Username and Password
The username and password that are used to access the ClickHouse database.
Time zone
The time zone where the ClickHouse database is deployed.
SSL
If SSL is configured for the destination data source, you can select SSL to protect data security.
VPC Data Source
If the ClickHouse database is deployed on a ECS and the network type is Alibaba Cloud VPC, select VPC Data Source and configure the following parameters:
AccessKey ID: the AccessKey ID that is used to purchase the instance.
For more information, see Obtain an AccessKey pair.
AccessKey: the AccessKey secret that is used to purchase the instance.
For more information, see Obtain an AccessKey pair.
Instance ID: the ID of the ECS instance.
Region: the region in which the ECS instance is deployed.
SSH
If you select SSH, you must configure the following parameters:
You can deploy a jump server and access the database over an SSH tunnel. To obtain the jump server information, contact O&M personnel or system administrators.
SSH Host: the IP address of the jump server.
SSH Username: the username that is used to log on to the jump server.
SSH Password: the password that is used to log on to the jump server.
SSH Port Number: the port number that is used to connect to the jump server. Default value: 22.
For more information, see Connect to a Linux instance by using a password.
Enable the file upload portal
You can upload files after you enable this function.
Click Test Connection to verify that the data source can be connected.
After the connectivity test is passed, click OK. Then, the ApsaraDB for SelectDB instance is added as a data source.
What to do next
After you add a data source, you can create a dataset and analyze data.
Add a table in the ClickHouse database or a user-created SQL statement to the Quick BI. For more information, see Create and manage datasets.
You can add charts for data analysis. For more information, see Create a dashboard and Overview of visualization charts.
Drill down the data for in-depth data analysis. For more information, see the Configure the drilling feature section of the "Drilling" topic.