All Products
Search
Document Center

ApsaraDB for ClickHouse:Quick BI

Last Updated:Aug 30, 2024

Quick BI is a next-generation self-service business intelligence (BI) platform that is tailored for cloud users and enterprises. Quick BI provides a GUI and supports flexible and efficient multidimensional analysis. Quick BI helps you gain fine-grained data-driven insights into your business. You can connect to ApsaraDB for ClickHouse over the Internet or a virtual private cloud (VPC), add an ApsaraDB for ClickHouse data source to Quick BI, and build a BI system for your ApsaraDB for ClickHouse cluster. This topic describes how to add an ApsaraDB for ClickHouse data source to Quick BI.

Prerequisites

  • An ApsaraDB for ClickHouse cluster is created. For more information, see Create an ApsaraDB for ClickHouse cluster.

  • The username and the password of a database account are created. For more information, see Create an account.

  • The version of your ApsaraDB for ClickHouse cluster is 20.3 or 22.8.

  • The CIDR blocks of Quick BI are added to the whitelist of ApsaraDB for ClickHouse. For more information, see Configure a whitelist.

    Note

    If you do not know how to obtain the CIDR blocks of Quick BI,follow the steps in the Procedure section to go to the Create Data Source panel. After you select a data source, the CIDR blocks of Quick BI are displayed below the Before you connect Quick BI to the data source, add the following CIDR blocks of Quick BI to the IP address whitelist of the data source section.

  • If Quick BI is not deployed in the same VPC as the ApsaraDB for ClickHouse cluster, you must apply for a public endpoint for the ApsaraDB for ClickHouse cluster. For more information, see Apply for and release a public endpoint.

Limits

  • Only workspace administrators and developers can add data sources.

  • Only Quick BI Enterprise Standard Version and Quick BI Advanced Version allow you to add ApsaraDB for ClickHouse data sources in group workspaces.

Procedure

  1. Log on to the Quick BI Console.

  2. In the top navigation bar, click the Workbench tab.

  3. In the left-side navigation pane, click Data Sources.

  4. In the upper-right corner of the Data Sources page, click Create Data Source.

  5. In the Create Data Source panel, click ClickHouse in the Database section.

  6. In the Configure Connection step, configure the parameters based on your network type.

    Internet

    Parameter

    Description

    Database source

    The source of the database. In this example, Alibaba Cloud is selected.

    Name

    The name of the data source. The name is displayed 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 that is used to connect to the ApsaraDB for ClickHouse cluster. Default value: 8123.

    Database

    The name of the database in the ApsaraDB for ClickHouse cluster.

    Username

    The username that you use to connect to the database in the ApsaraDB for ClickHouse cluster.

    Password

    The password that you use to connect to the database in the ApsaraDB for ClickHouse cluster.

    Time Zone

    The time zone of the database in the ApsaraDB for ClickHouse cluster.

    SSL

    If SSL is configured for the data source that you want to add, you can turn on SSL to protect data security.

    VPC Data Source

    If you use the Internet to connect Quick BI to the data source, VPC Data Source is turned off by default.

    Initialize SQL

    If Initialize SQL is turned on, you can configure the SQL statement that is initialized and executed after the data source is connected.

    The SQL statements that are initialized and executed after each data source is connected can only be SET statements. The statements are separated with semicolons (;).

    Enable File Upload

    If you select Enable File Upload, you can upload files.

    VPC

    Parameter

    Description

    Database source

    The source of the database. In this example, Alibaba Cloud is selected.

    Name

    The name of the data source. The name is displayed 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 that is used to connect to the ApsaraDB for ClickHouse cluster.

    Database

    The name of the database in the ApsaraDB for ClickHouse cluster.

    Username

    The username that you use to connect to the database in the ApsaraDB for ClickHouse cluster.

    Password

    The password that you use to connect to the database in the ApsaraDB for ClickHouse cluster.

    Time Zone

    The time zone of the database in the ApsaraDB for ClickHouse cluster.

    VPC Data Source

    Turn on VPC Data Source and configure the following parameters:

    • AccessKey ID: the AccessKey ID that is used to purchase the cluster. For more information, see Obtain an AccessKey pair.

    • AccessKey Secret: the AccessKey secret that is 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 is deployed.

    Initialize SQL

    If Initialize SQL is turned on, you can configure the SQL statement that is initialized and executed after the data source is connected.

    The SQL statements that are initialized and executed after each data source is connected can only be SET statements. The statements are separated with semicolons (;).

    Enable File Upload

    If you select Enable File Upload, you can upload files.

  7. Click Test Connection to verify that the data source can be connected.

  8. After the data source passes the connectivity test, click OK.

    The data source that you created is displayed in the My Data Sources list.

What to do next

After you add a data source, you can create a dataset and analyze data.