This topic guides you through the process of adding a ClickHouse data source in Quick BI, enabling you to connect to a ClickHouse database and analyze data within Quick BI. You can establish this connection via the Internet or an Alibaba Cloud VPC.
Prerequisites
Ensure your network is connected:
For Internet connections, add the IP address of Quick BI to the database whitelist. For more information, see add security group rule.
For internal network connections, ensure connectivity between the data source and Quick BI using one of the following methods:
If the ClickHouse database is hosted on an Alibaba Cloud ECS instance, establish a connection through an Alibaba Cloud VPC.
Alternatively, deploy a jump server and access the database via an SSH tunnel.
Retrieve the username and password for the user-created ClickHouse database.
Limits
Data source addition is restricted to workspace and organization administrators.
ClickHouse data sources are supported exclusively by Quick BI Pro and the Professional Edition.
Compatible with versions 20.3 and 22.8.
Procedure
Log on to the or the international Quick BI console.
Follow the steps illustrated below to add a data source.
Navigate to the data source creation page via the data source creation entry.
Select the ClickHouse data source.
Choose the user-created data source type.
In the Configure Connection dialog box, configure the connection according to your business needs.
Name
Description
Display Name
The display name in the data source configuration list. Enter a standard name that does not 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
The port of the address where the ClickHouse database is deployed.
Database
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 the destination data source is configured with SSL, you can select the secure protocol SSL to protect data security.
VPC Data Source
If the ClickHouse database is deployed on Alibaba Cloud ECS and the network type is Alibaba Cloud VPC, select VPC Data Source and configure the following parameters:
Purchaser Accessid: The AccessKey ID of the purchaser of this instance.
For more information, see obtain AccessKey.
NoteEnsure that the AccessKey ID has Read permission on the destination instance. If it also has Write permission, the system automatically adds the whitelist. Otherwise, you need to add it manually. For more information, see create a custom policy.
Purchaser Accesskey: The AccessKey Secret of the purchaser of this instance.
For more information, see obtain AccessKey.
Instance ID: The ECS instance ID. Log on to the ECS console and obtain the instance ID on the instance tab.
For more information, see view instance information.
Area: The area where the ECS instance is located.
For more information, see view instance information.
SSH
If you select SSH, you need to 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: Enter 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 corresponds to the username used to log on to the jump server.
SSH Port: The port of the jump server. Default value: 22.
For more information, see log on to a Linux instance by using password authentication.
Initialization SQL
After it is enabled, you can configure the SQL statement that is executed to initialize the data source connection.
Only SET statements are allowed in the SQL statement that is executed to initialize the data source connection. Separate multiple statements with a semicolon.
Enable file upload entry
After it is enabled, file upload is supported.
Click Connection Test to verify the data source connectivity.
Once the test is successful, click OK to finalize the addition of the data source.
What to Do next
Once the data source is established, you can proceed to create datasets and analyze data.
To incorporate data tables from the ClickHouse database or custom SQL into Quick BI, refer to create and manage datasets.
For adding visualization charts and data analysis, consult create a dashboard and overview of visualization charts.
For in-depth data analysis, see drill settings and display.