Connect to OceanBase Database in Quick BI and obtain data

This topic describes how to connect to a MySQL tenant of OceanBase Database in Quick BI Enterprise Standard Version for data display.

Prerequisites

• You have purchased Quick BI Enterprise Standard Version. For more information about the Quick BI versions and billing methods, see Billing Methods.

• You have installed OceanBase Database and created a MySQL tenant.

Procedure

Step 1: Obtain the OceanBase Database connection string

Contact the deployment personnel or administrator of OceanBase Database to obtain the connection string. The following is a connection string example:

obclient -h$host -P$port -u$user_name -p$password -D$database_name

The parameters are described as follows:

• $host: the IP address for connecting to OceanBase Database. It is the IP address of OceanBase Database Proxy (ODP) for connection through ODP, or the IP address of an OBServer node for direct connection.

• $port: the port for connecting to OceanBase Database. For connection through ODP, the default value is 2883, which can be customized when ODP is deployed. For direct connection, the default value is 2881, which can be customized when OceanBase Database is deployed.

• $database_name: the name of the database to be accessed.

  Notice

  The user for connecting to a tenant must have the CREATE, INSERT, DROP, and SELECT privileges on the database. For more information about user privileges, see Privilege types in MySQL-compatible mode.

• $user_name: the tenant account. For connection through ODP, two account formats are supported: username@tenant name#cluster name and cluster name:tenant name:username. For direct connection, the username@tenant name format is supported.

• $password: the password of the account.

For more information about the connection string, see Connect to an OceanBase Database tenant by using OBClient.

Here is an example:

obclient -hxxx.xxx.xxx.xxx -P2881 -utest_user001@mysql001 -p****** -Dtest

Step 2: Connect to OceanBase Database in Quick BI

1. Log in to the Quick BI console and choose New > Data Sources. On the Create Data Source page, search for OceanBase and select Alibaba OceanBase.

2. Set related parameters based on the connection string obtained in Step 1. The parameters are described as follows:

   Parameter	Description
   Display Name	The name of the data source.
   Schema	Select MySQL.
   Database Address	The IP address for connecting to OceanBase Database. The value is sourced from the -h parameter in the connection string.
   Port Number	The port for connecting to OceanBase Database. The value is sourced from the -P parameter in the connection string.
   Database	The name of the database to be accessed. The value is sourced from the -D parameter in the connection string.
   Username	The username of the account. The value is sourced from the -u parameter in the connection string.
   Password	The password of the account. The value is sourced from the -p parameter in the connection string.

3. Click Test Connection. When the message "The data source can be connected" appears on the top of the page, you can connect to OceanBase Database.

4. Click OK. If the page shown in the following figure appears, it indicates that you have successfully connected to the MySQL tenant of OceanBase Database and added the tenant as a data source.

What to do next

Quick BI will be ready for use after the MySQL tenant of OceanBase Database has been added as a data source. For more information about how to use Quick BI, see Quick BI documentation.