Create a physical OceanBase data source

2025-06-04 08:36:33  Updated

You must configure data sources before you create a data migration project. Before you start a data migration or synchronization project, you can add an OceanBase database as the source or destination data source. This topic describes how to create a physical OceanBase data source in OceanBase Migration Service (OMS).

Prerequisites

  • You have obtained the IP address and port number of the related database.

  • You have created a database user for data migration.

    We recommend that you create a dedicated database user for the data migration project and grant the required data operation privileges to the user. For more information, see Create a database user.

Procedure

  1. Log on to the OMS console.

  2. In the left-side navigation pane, click Data Source Management.

  3. On the Data Source Management page, click New Data Source in the upper-right corner.

    data-source5-en

  4. In the New Data Source dialog box, configure the parameters. Data Source Type is set to OceanBase and Physical Data Source is selected by default.

    data-source3-en

    Parameter Description
    Data Source Identifier We recommend that you set it to a combination of digits and letters. It must not contain any spaces and cannot exceed 32 characters in length.
    Notice
    The data source identifier must be globally unique in OMS.
    Region Select the region where the data source resides from the drop-down list. The region is the value that you set for the cm_region parameter when you deploy OMS.
    Notice
    • This parameter is displayed only when multiple regions are available.
    • Make sure that the mappings between the data source and the region are consistent. Otherwise, the migration and synchronization performance can be poor.
    Tenant Type The type of the OceanBase Database tenant. Valid values: Oracle and MySQL.
    OCP Cluster (Optional) The OceanBase Cloud Platform (OCP) cluster associated with the data source. Select an OCP cluster from the drop-down list.
    Note
    • Check whether the data source is managed in the selected OCP cluster.
    • This parameter allows OMS to obtain the incremental logs of OceanBase Database. If you do not set this parameter, you cannot select Incremental Synchronization or Reverse Incremental Migration.
    If the OCP cluster is not available in the list, click Add OCP Cluster and configure the parameters on the Add Associated OCP Cluster page. For more information, see Associate with OCP.
    Input Method Valid values: Manual Input and Command-line Connection String.
    • Manual Input: Enter the public IP address and port number of the OceanBase database.
    • Command-line Connection String: Enter a command-line connection string.
    Host IP Address The IP address of the host where the database is located.
    Port The port number of the host where the database is located.
    Tenant Name The name of the OceanBase Database tenant.
    Cluster Name The name of the cluster to which the OceanBase Database tenant belongs.
    Database Username The username of the OceanBase database user for data migration or synchronization. We recommend that you create a dedicated database user for data migration or synchronization.
    Database Password The password of the database user.
    DB Name (Optional) The name of the database. This parameter is required only when the Tenant Type parameter is set to MySQL.
    Note
    If this parameter is specified, you can select migration or synchronization objects only in the specified database when the data source serves as the source of a data migration or synchronization project.
    Schema Name (Optional) The name of the schema. This parameter is required only when the Tenant Type parameter is set to Oracle.
    Note
    • If this parameter is specified, you can select only migration or synchronization objects in the specified schema when the data source serves as the source of a data migration or synchronization project.
    • If this parameter is not specified, you can select all accessible schemas as the migration or synchronization objects.
    Remarks (Optional) Additional information about the data source.
  5. Optional. In the Create Data Source dialog box, click Show next to Advanced Options to set the parameters as needed.

    data-source4-en

    Parameter Description
    DRC User Name (Optional) The username of the data replication center (DRC) user intended for reading database incremental logs and database object schemas in OceanBase Database. You must create this user in the sys tenant of your business cluster.
    Password (Optional) The password of the DRC user.
    Configurl (Optional) The actual IP address of the server that runs OceanBase Database.
    • If you select OCP Cluster, this parameter is not displayed. OMS obtains the configurl from the OCP cluster to which the server belongs by default.
    • If you do not select OCP Cluster, you can specify the Username and Password parameters, click Search in OBServer next to ConfigUrl to obtain the IP address from the corresponding OBServer.
      If the query fails, you can run the show parameters like 'obconfig_url' command in the sys tenant of OceanBase Database. The returned value is the configurl.
    • If OCP is not deployed, you must deploy the web service config server to access the OceanBase metadata.
    __OCEANBASE_INNER_DRC_USER Password (Optional) The password of the __OCEANBASE_INNER_DRC_USER admin user. The admin user is used to migrate tables without unique keys in OceanBase Database. Note that you must create this user under the tenant where the current data source is located.
    • When you create a project to migrate or synchronize data from a physical OceanBase data source, you must perform the following operations:

      • You must enter the username and password for schema migration, schema synchronization, and incremental synchronization. If you do not specify OCP Cluster, you must specify Configurl.

      • When you migrate a table without a unique key, you must enter the password of the __OCEANBASE_INNER_DRC_USER user.

    • When you create a project to migrate data to a physical OceanBase data source, you must specify the username and password for reverse incremental migration. If you do not specify OCP Cluster, you must specify Configurl.

  6. Click Test Connection to test the network connection between OMS and the data source, and the validity of the username and password.

  7. After the test is passed, click OK.

Contact Us