Connect to OceanBase Cloud in Quick BI

This topic will use Quick BI Enterprise Edition and OceanBase Cloud MySQL compatible mode tenant as an example to demonstrate how to connect to OceanBase Cloud for data presentation in Quick BI.

Prerequisites

• You have purchased Quick BI Enterprise Edition. For more version options and specific purchase details, please refer to Quick BI billing.

• You have registered an OceanBase Cloud account, and have created a cluster instance and a MySQL-compatible tenant. For details, refer to Create a cluster instance and Create a tenant.

Procedure

Step 1: Obtain the IP addresses of Quick BI

Before obtaining the OceanBase Cloud connection string to connect in Quick BI, you need to obtain the IP addresses of Quick BI and add these addresses to the allowlist of the OceanBase Cloud tenant (as instructed in Step 2: Obtain an OceanBase Cloud connection string) to ensure successful connection later.

1. Log in to the Quick BI console.

2. Under the Workbench tab, select New > Data Sources.

   

3. On the Create Data Source page, under the Database section, select MySQL, and then select User-created as the Database source.

4. At the bottom of the page, click Copy Whitelist to save the IP addresses of Quick BI.

   

Step 2: Obtain an OceanBase Cloud connection string

1. Log in to the OceanBase Cloud console. On the Instances page, expand the target instance and click Create under the target tenant.

   

2. In the pop-up window, click Connect with Public IP.

3. In the Connect with Public IP window, complete the following settings to generate the connection string:

   1. Under 1. Add an IP address to the allowlist, click Add to add your exit IP address(es) used for the connection to the allowlist.

   2. (Optional) Under 2. Download the CA certificate to connect securely to the tenant, download the CA certificate and complete the verification.

   3. Under 3. Connect to your instance, click the drop-down list for Database and Account to create a database and an account for the connection. Select MySQL CLI as the connection method.

      Notice

      Please keep your password in a secure place after creating your account.

      

Step 3: Connect to OceanBase Cloud in Quick BI

1. Navigate back to the Quick BI console opened in Step 1, and on the MySQL - User-created page, continue the following configuration based on the connection string obtained in Step 2: Obtain an OceanBase Cloud connection string:

   Field	Description
   Display Name	Specify a data source name.
   Database Address	Taken from the -h parameter in the connection string, which is the hostname of OceanBase Cloud database, for example, t5******.aws-ap-southeast-1.oceanbase.cloud.
   Port Number	Taken from the -P parameter in the connection string, which is the OceanBase Cloud database connection port.
   Database	Taken from the -D parameter in the connection string, which is the name of the database to be accessed.
   Username	Taken from the -u parameter in the connection string, which is the account name, for example: test.
   Password	Taken from the -p parameter in the connection string, which is the account password.
   Database Version	Select 5.7.

   

2. Click Test Connection. When the top pop-up window displays The data source can be connected, it means that OceanBase Cloud can be connected correctly.

   

3. Click OK. If the page displays as shown below, it means you have successfully connected and added OceanBase Cloud as a data source.

   

What's next

After creating the data source, you can start using Quick BI. For detailed operation guides on Quick BI, refer to the Quick BI user guide.