Add an OceanBase data source

Updated at:

Connect Quick BI to your Alibaba Cloud OceanBase database over the public network or through a VPC to analyze and visualize data.

Prerequisites

A cluster and tenant are created. Create a cluster and Create a tenant.

Overview

Add your Alibaba Cloud OceanBase Database as a data source in Quick BI to analyze and visualize its data.

Quick BI connects to OceanBase over the public network or through a VPC. The configuration varies by connection type.Network connectivity overview

Add the Quick BI IP CIDR blocks to your OceanBase Whitelist Groups to prevent connection failures.

Limits

  • Only workspace administrators and developers can add data sources.

  • Only OceanBase Database versions 4.2.1.3 and 4.3 are supported.

Procedure

  1. Add IP addresses to the whitelist.

    For public network connections, add the Quick BI IP addresses to your OceanBase Whitelist Groups.

  2. Log on to the Quick BI console.

    1. Go to the Add Data Source page. Create a data source.

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

  3. In the Configure Connection dialog box, set the following parameters.image

    Parameter

    Description

    Display name

    The display name in the data source list.

    No special characters or leading/trailing spaces allowed.

    Mode

    The tenant mode of your OceanBase database: MySQL Mode or Oracle Mode.

    In the OceanBase Management Console, find Tenant Mode on the tenant details page.Tenant mode

    • If Tenant Mode is MySQL Tenant, select MySQL Mode.

    • If Tenant Mode is Oracle Tenant, select Oracle Mode.

    Database address and port

    The public address and port of your OceanBase database. For VPC connections, use the internal address and port.

    In the OceanBase Management Console, go to the tenant details page and find the Database Address and port on the Connection Information tab.

    image

    Obtain connection parameters.

    Database

    The name of the database in your OceanBase tenant.

    In the OceanBase Management Console, find the Database Name on the Database tab of the tenant details page.Database name

    Username and password

    The username and password for your OceanBase database.

    VPC data source

    To connect through a VPC, select VPC data source and configure these parameters:

    • AccessKey ID and AccessKey Secret: The AccessKey pair of an account with access to the target OceanBase cluster.

      Obtain your AccessKey pair from the RAM console.

      Note
      • MySQL Mode: The account needs Read permissions for the target instance. With List and Write permissions, Quick BI auto-adds its IPs to the whitelist. Otherwise, add them manually.

      • Oracle Mode: The account needs Read permissions for the target instance. With Write permissions, Quick BI auto-adds its IPs to the whitelist. Otherwise, add them manually.

      Obtain AccessKey

    • Instance ID and Region: The cluster ID and region.

      In the OceanBase Management Console, find the cluster ID and region on the cluster list page.Instance ID

    Note

    For VPC data source, enter the internal address and port in the Database address and port fields.

  4. Click Test Connection.

    image

  5. After the test succeeds, click OK.

Next steps

After the data source is added, create a dataset to start analyzing data.