How to add an ApsaraDB for ClickHouse data source - ApsaraDB for ClickHouse

Quick BI is a next-generation, self-service business intelligence (BI) platform tailored for cloud users and enterprises. Its intuitive visualization and flexible multi-dimensional analysis help you turn data into business insights. You can connect Quick BI to an ApsaraDB for ClickHouse data source over the Internet or a VPC to build a BI system. This article describes how to add an ApsaraDB for ClickHouse data source in Quick BI.

Prerequisites

You have an active ApsaraDB for ClickHouse cluster. For more information, see Create a cluster.
You have created a database account and password. For more information, see Create an account.
The cluster version is 20.3 or 22.8.
The IP address of Quick BI has been added to the whitelist of ApsaraDB for ClickHouse. For more information, see Configure a whitelist.

Note
If you do not know the Quick BI IP addresses, follow the steps in the Procedure section to go to the Create Data Source panel. The required IP addresses are listed at the bottom of the panel under Before you connect, add the following whitelist entries.
If your Quick BI instance and ApsaraDB for ClickHouse cluster are in different VPCs, you must apply for a public endpoint for the cluster. For more information, see Apply for and release a public endpoint.

Limitations

Only workspace administrators and developers can add data sources.
You can create ClickHouse data sources only in group workspaces of Quick BI Professional and Quick BI Advanced.

Procedure

Log on to the Quick BI console.
In the top navigation bar, click Workbench.
In the left-side navigation pane, click Data Source.
On the Data Source page, click New Data Source.
In the Create Data Source panel, find the Databases section and click ClickHouse.

On the Add ClickHouse Data Source page, configure the parameters based on your network type.

Internet

Parameter	Description
Data source	Select Alibaba Cloud.
Display name	The display name of the data source in the data source list. The name can contain letters, digits, underscores (_), and hyphens (-).
Database address	The public endpoint of the ApsaraDB for ClickHouse cluster.
Port number	The port number of the ApsaraDB for ClickHouse cluster. The default is 8123.
Database	The name of the database in the ApsaraDB for ClickHouse cluster.
Username	The username of the database account for the ApsaraDB for ClickHouse cluster.
Password	The password for the database account.
Time Zone	The time zone of the ApsaraDB for ClickHouse database.
SSL	If your data source uses SSL, you can enable the SSL option to secure data transmission.
VPC Data Source	If you connect to the data source over the Internet, this switch is turned off by default.
Initialize SQL	Enable this option to specify SQL statements that run after a connection is established. Only SET statements are allowed. Separate multiple statements with semicolons (;).
Enable File Upload	After you turn on this switch, you can upload files.

VPC

Parameter	Description
Data source	Select Alibaba Cloud.
Display name	The display name of the data source in the data source list. The name can contain letters, digits, underscores (_), and hyphens (-).
Database address	The internal endpoint of the ApsaraDB for ClickHouse cluster.
Port number	The port number of the ApsaraDB for ClickHouse cluster.
Database	The name of the database in the ApsaraDB for ClickHouse cluster.
Username	The username of the database account for the ApsaraDB for ClickHouse cluster.
Password	The password for the database account.
Time Zone	The time zone of the ApsaraDB for ClickHouse database.
VPC Data Source	Turn on the VPC Data Source switch and configure the following parameters: AccessKey ID: The AccessKey ID of the Alibaba Cloud account that was used to purchase the cluster. For more information, see Obtain an AccessKey pair. AccessKey Secret: The AccessKey secret of the Alibaba Cloud account that was used to purchase the cluster. For more information, see Obtain an AccessKey pair. Instance ID: The ID of the ApsaraDB for ClickHouse cluster. Region: The region in which the ApsaraDB for ClickHouse cluster resides.
Initialize SQL	Enable this option to specify SQL statements that run after a connection is established. Only SET statements are allowed. Separate multiple statements with semicolons (;).
Enable File Upload	After you turn on this switch, you can upload files.

Click Test Connection to verify the connection.
If the connection test is successful, click OK.

After the data source is created, it appears in the My Data Sources list.

What to do next

After you create the data source, you can create datasets and analyze data.

Create a dataset from your ApsaraDB for ClickHouse tables or by using custom SQL queries. For more information, see Create a dataset.
To add visualizations and analyze data, see Create a dashboard and Visualization overview.
To drill down and analyze data in depth, see Step 3: Configure and display drill-downs.