ApsaraDB for ClickHouse data source

Limits

• Only workspace administrators and developers can add data sources.

• Only the Professional and Advanced editions of Quick BI support creating ApsaraDB for ClickHouse data sources.

• Versions 20.3, 22.8, and 23.8 are supported.

Procedure

1. Add IP addresses to the whitelist.

   Before you connect to ApsaraDB for ClickHouse, add the IP addresses of Quick BI to the whitelist of your ApsaraDB for ClickHouse cluster. For configuration instructions, see Configure a whitelist.

2. Test the data source connection and create the data source.

   1. Log on to the Quick BI console.

   2. Follow the steps in the following figure to add a data source.

      1. Go to the Create Data Source page from the Create data source entry point.

      2. On the Alibaba Cloud Databases tab, click ClickHouse.

3. In the Configure Connection dialog box, configure the following parameters.

   Parameter	Description
   Display name	A user-friendly name for this data source. This name appears in the Quick BI data source list.
   Database address and port	The public endpoint of the ApsaraDB for ClickHouse database. If you use a VPC data source, enter the internal endpoint and internal port. Log on to the ApsaraDB for ClickHouse console and obtain the database address from the Network Information section. Example: cc-xxxxxxxxxxxxxxxxxx.ads.rds.aliyuncs.com.
   Database	The name of the database you want to connect to.
   Username and password	The credentials used to access your database.
   Time zone	The time zone where your ApsaraDB for ClickHouse database is deployed.
   Database version	Select the version of your ApsaraDB for ClickHouse database. Select 23.8 if your database version is 23.8 or later. Otherwise, select 22.8.
   SSL	If your target data source is configured with SSL, select this option to protect your data in transit.
   VPC data source	If your database uses an Alibaba Cloud VPC, select VPC data source and configure the following parameters: AccessKey ID: The AccessKey ID of the Alibaba Cloud account that has permissions for the instance. For more information, see Obtain an AccessKey pair. Note Make sure that the AccessKey ID has the Read permission on the target instance. If it also has the Write permission, the system automatically adds the required IP addresses to the whitelist. Otherwise, you must add them manually. For more information, see Create a custom RAM policy. AccessKey Secret: The AccessKey Secret of the Alibaba Cloud account that has permissions for the instance. For more information, see Obtain an AccessKey pair. Instance ID: The ID of the ApsaraDB for ClickHouse instance. Log on to the ApsaraDB for ClickHouse console and obtain the instance ID from the cluster list. For more information, see ApsaraDB for ClickHouse data source. Region: The region where the ApsaraDB for ClickHouse instance is deployed. Instance edition: The edition of your instance. Note If you select VPC data source, you must enter the internal endpoint and port for the Database address and port fields.
   Initial SQL	Configure SQL statements to run immediately after a connection is established. Only SET statements are allowed. Separate multiple statements with a semicolon (;).
   Enable file upload entry	If enabled, file uploads are supported.

4. Click Test Connection to verify your connection settings.

5. If the connection test is successful, click OK.