All Products
Search
Document Center

Quick BI:Add a OceanBase Data Source

Last Updated:Jun 25, 2025

After you add an ApsaraDB for OceanBase data source that connects an ApsaraDB for OceanBase database to Quick BI, you can analyze and view data in the database in the Quick BI console. Quick BI allows you to access ApsaraDB for OceanBase over the Internet or a virtual private cloud (VPC). This topic describes how to add an ApsaraDB for OceanBase data source.

Prerequisites

A cluster and a tenant must be created. For more information, see Create a cluster and Create a tenant.

Background information

When using the ApsaraDB for OceanBase database, you can integrate an OceanBase cloud data source with Quick BI for data analysis. For more information about ApsaraDB for OceanBase, see ApsaraDB for OceanBase.

To prevent data access issues due to whitelist restrictions, you need to add Quick BI's IP address segments for different network environments to the data source's whitelist. For more information about configuration, see Whitelist group.

Limits

  • Only space administrators and developers are permitted to add data sources.

  • The service supports Alibaba OceanBase database versions 4.2.1.3 and 4.3 only.

Procedure

  1. Add a whitelist.

    Before connecting to the ApsaraDB for OceanBase database over the Internet, add the IP address of Quick BI to OceanBase's whitelist. For more information about adding to an OceanBase whitelist, see Whitelist group.

  2. Log on to the Quick BI console.

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

    1. Navigate to the data source creation page via the data source creation entry.

    2. On the Alibaba Cloud Database tab, select OceanBase data source.image

  4. In the New Data Source dialog box, configure the settings according to your business needs. image

    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.

    Mode

    The tenant mode that is used when you deploy the ApsaraDB for OceanBase database. Valid values: MySQL Mode and Oracle Mode.

    Log on to the OceanBase Management Console and view the Tenant Mode on the tenant details page.

    • If the Tenant Mode of the database is MySQL Tenant, select MySQL Mode.

    • If the Tenant Mode of the database is Oracle Tenant, select Oracle Mode.

    Database Address and Port

    The public address and corresponding port of the deployed ApsaraDB for OceanBase database. If you use a VPC data source, you need to enter the internal address and internal port of the deployed database.

    Log on to the OceanBase Management Console and obtain the Database Address and corresponding port number on the Connection information tab of the tenant details page.

    Database

    The name of the database that is customized when you deploy the database.

    Log on to the OceanBase Management Console and obtain the Database name on the Database tab of the tenant details page.

    Username and Password

    The username and password that are used to access the ApsaraDB for OceanBase database.

    VPC Data Source

    If you use the Alibaba Cloud VPC network, select VPC Data Source and configure the following parameters:

    • Purchaser AccessId and Purchaser AccessKey: The AccessKey ID and AccessKey Secret that have access privileges to the destination OceanBase cluster.

      Log on to the RAM console and obtain the AccessKey ID and AccessKey Secret.

      Note
      • If the selected mode is MySQL, ensure that the account has Read permission on the destination instance. In addition, if the account has List and Write permissions, the system will automatically add the whitelist. Otherwise, you need to add it manually.

      • If the selected mode is Oracle, ensure that the account has Read permission on the destination instance. In addition, if the account has Write permission, the system will automatically add the whitelist. Otherwise, you need to add it manually.

    • Instance ID and Area: The OceanBase cluster ID and the zone where it is located.

      Log on to the OceanBase Management Console and obtain the cluster ID and zone on the cluster list page.

    Note

    If you select the VPC data source, you need to enter the internal address and internal port for the database address and port.

  5. Click Connection Test to verify the data source connectivity.

    image

  6. Once the test is successful, click OK to finalize the data source addition.

What to do next

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