Quick BI:Add a ClickHouse Data Source

Limits

• Only workspace administrators and organization administrators can add data sources.

• Only Quick BI Pro and Professional Edition support ClickHouse data sources.

• Versions 20.3, 22.8, and 23.8 are supported.

Procedure

1. Log on to the Quick BI console.

2. Perform the steps that are shown in the following figure to add a ClickHouse data source.

   1. Go to the Create Data Source page from the entry for creating a data source.

   2. On the User-created Data Source tab, select ClickHouse data source.

3. In the Configure Connection dialog box, complete the configurations based on your business scenario.

   Name	Description
   Display 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	The port of the address where the ClickHouse database is deployed. Default value: 8123.
   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.
   Database Version	Select the version of the ClickHouse database. If the database version is 23.8 or later, select 23.8. If the database version is earlier than 23.8, select 22.8.
   SSL	If the destination data source has SSL configured, you can select the SSL security protocol to protect data security.
   VPC Data Source	If the ClickHouse database is deployed on an Alibaba Cloud ECS instance and the network type is Alibaba Cloud VPC, select VPC Data Source and configure the following parameters: Buyer's AccessId: The AccessKey ID of the user who purchased the instance. For more information, see Obtain an AccessKey pair. Note Make sure that the AccessKey ID has the Read permission on the destination instance. If the AccessKey ID has the Write permission, the system automatically adds the whitelist. Otherwise, you need to manually add the whitelist. For more information, see Create a custom access policy. Buyer's AccessKey: The AccessKey Secret of the user who purchased the instance. For more information, see Obtain an AccessKey pair. Instance ID: The ID of the ECS instance. Log on to the ECS console and obtain the instance ID on the Instances tab. For more information, see View instance information. Region: The region 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 connect to 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 that is used to log on to the jump server. SSH Port: The port of the jump server. Default value: 22. For more information, see Connect to a Linux instance by using a password. Note The SSH address must be a public IP address. Internal IP addresses are not supported.
   Initialize SQL	After you enable this feature, you can configure the SQL statement that is executed after the data source is connected. The SQL statement that is executed after each data source connection is initialized. Only SET statements are allowed, and statements are separated by semicolons.
   Enable File Upload Entry	After you enable this feature, file upload is supported.

• Click Test Connection to test the connectivity of the data source.

  

• After the test is successful, click OK to add the data source.