ByteHouse Cloud Data Warehouse Version
ByteHouse Cloud Data Warehouse Version
- Documentation
ByteHouse Cloud Data Warehouse VersionUser guideEcosystemBI toolQuickBI
Copy page
Download PDFCopy pageDownload PDFQuick BI supports connecting to BytePlus ByteHouse over the public network. As ByteHouse supports both ClickHouse and MySQL drivers, you can choose the connection method according to your preference. Once connected, you can analyze and display data on Quick BI. This article introduces how to add ByteHouse (ClickHouse driver) and ByteHouse (MySQL driver) data sources in QuickBI.
As Alibaba Cloud QuickBI is a SaaS cloud-based BI tool, it only supports data interfacing via the public network. Therefore, before interfacing with QuickBI, you need to follow the steps below to prepare for the public network interfacing on the ByteHouse side.
Step1: Configure public domain name
After logging in to the ByteHouse console, go to the tenant management basic information page at the top, check the network group configuration, and ensure it is linked to a VPC and associated with a public domain name.
- If not linked to a VPC and public domain name, you need to follow the Network information settingsdocument to complete the configuration.
- After completing the binding, you can click to copy the public Domain Name for subsequent configuration of QuickBI parameters.
Step 2: Obtain API Key
Go to the Tenant Management Connection Information page at the top, create a new API key in the API Key module, and save the API key locally for later Configuration use.
tip
An account can create at most two API Keys. If you have previously created an API Key, you can also use the already created API Key.
Step 3: Set Default Compute Group
Go to the Tenant Management Parameter Setting page at the top, view the default compute group that has been set, and ensure that this compute group is in a running state and has not been stopped. The data query and other operations after QuickBI integrates with ByteHouse will use the default compute group configured here.
ByteHouse supports both ClickHouse and MySQL drivers. When integrating with QuickBI, based on usage preferences, you can choose to use either ClickHouse or MySQL driver. Both integration methods have similar Configuration settings. The key points of the integration configuration are shown below, with detailed interfaces as per QuickBI's product specifications.
Step 1: Create Data Source
- Log in to the Quick BI Console, enter the data source creation interface from the Create Data Source entry, and select a MySQL data source or ClickHouse data source based on usage preferences.
- Configure data source integration parameters. You can refer to and change the following core integration parameters; keep other parameters at their default settings.
Name | Configuration Description: MySQL Datasource | Configuration Description: ClickHouse Datasource |
|---|---|---|
Database Source | Select: Self-built. | |
Display Name | Customize the display name of the datasource. Please type in a standard name; avoid using special characters and do not include spaces before or after. | |
Database address | Configuration is as set on the ByteHouse side, obtained from tenant management>basic information>network information in the public domain name. | |
Port | The corresponding port number of the database, keep the default | The corresponding port number of the database, keep the default |
Database | Custom database name when deploying the ByteHouse database. | |
Username and Password | Username and password for logging into the ByteHouse database.
| |
Database Version | Suggestion: Select 8.0. The current version MySQL 8.0 has been verified and can function normally; it is recommended to use this version. | No involvement |
SSL | Activate the Security Agreement SSL. warning ByteHouse requires encrypted authentication to protect data security; therefore, you need to enable SSL. | |
- Click Connection Test to conduct a connectivity test for the data source. After a successful test, click Confirm to complete adding the data source.
tip
If the connection test failed, please check if the configuration parameters are correct and if ByteHouse's default calculation group is functioning properly. If the default calculation group has not been set up or if its state is abnormal, it might cause the connection test to fail.
Step 2: QuickBI Validation
- You can verify the integration of QuickBI with ByteHouse by creating datasets.
In the QuickBI Create Dataset page, you can select the ByteHouse MySQL or ClickHouse data source created in the steps above and create datasets based on the data source. For more details on dataset operations, please see Alibaba Cloud Help Documentation. - You can also create data analysis dashboards based on ByteHouse datasets, with operation details available in Alibaba Cloud Help Documentation.
