OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

Product Overview
DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Resources

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS

OceanBase Cloud

OceanBase Database

Tools

Connectors and Middleware

QUICK START

OceanBase Cloud

OceanBase Database

BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
Start on Cloud

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

Product Overview
DEPLOY YOUR WAY

OceanBase Cloud

The best way to deploy and scale OceanBase

OceanBase Enterprise

Run and manage OceanBase on your infra

TRY OPEN SOURCE

OceanBase Community Edition

The free, open-source distributed database

OceanBase seekdb

Open source AI native search database

Customer Stories

Real-world success stories from enterprises across diverse industries.

View All
BY USE CASES

Mission-Critical Transactions

Global & Multicloud Application

Elastic Scaling for Peak Traffic

Real-time Analytics

Active Geo-redundancy

Database Consolidation

Comprehensive knowledge hub for OceanBase.

Blog

Live Demos

Training & Certification

Documentation

Official technical guides, tutorials, API references, and manuals for all OceanBase products.

View All
PRODUCTS
OceanBase CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase Database
BEST PRACTICES

Practical guides for utilizing OceanBase more effectively and conveniently

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Migration Service

V4.0.2Enterprise Edition

    Download PDF

    OceanBase logo

    The Unified Distributed Database for the AI Era.

    Follow Us
    Products
    OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
    Resources
    DocsBlogLive DemosTraining & CertificationTicket
    Company
    About OceanBaseTrust CenterLegalPartnerContact Us
    Follow Us

    © OceanBase 2026. All rights reserved

    Cloud Service AgreementPrivacy PolicySecurity
    Contact Us
    Document Feedback
    1. Documentation Center
    2. OceanBase Migration Service
    3. V4.0.2
    iconOceanBase Migration Service
    V 4.0.2Enterprise Edition
    Enterprise Edition
    • V 4.3.2
    • V 4.3.1
    • V 4.3.0
    • V 4.2.5
    • V 4.2.4
    • V 4.2.3
    • V 4.0.2
    • V 3.4.0
    Community Edition
    • V 4.2.13
    • V 4.2.12
    • V 4.2.11
    • V 4.2.10
    • V 4.2.9
    • V 4.2.8
    • V 4.2.7
    • V 4.2.6
    • V 4.2.5
    • V 4.2.4
    • V 4.2.3
    • V 4.2.1
    • V 4.2.0
    • V 4.0.0
    • V 3.3.1

    Create a physical OceanBase data source

    Last Updated:2026-04-14 07:36:47  Updated
    share
    What is on this page
    Prerequisites
    Procedure

    folded

    share

    You must configure data sources before you create a data migration project. To migrate data from or to an OceanBase database, you must add the OceanBase database as the source or destination data source. This topic describes how to create an 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 and authorize 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 Create Data Source in the upper-right corner.

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

      Parameter
      Description
      Data Source Identifier We recommend that you set it to a combination of Chinese characters, digits, and letters. It must not contain any spaces and cannot exceed 32 characters in length.
      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 Community Edition.
      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 ensures that OMS obtains the incremental data of the OceanBase database. If you do not set this parameter, you cannot select Incremental Migration, 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.
      Connection Mode 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.
      Database Name Optional. The name of the database. This parameter is required only when the Tenant Type parameter is set to MySQL.
      Schema Name Optional. The name of the schema. This parameter is required only when the Tenant Type parameter is set to Oracle.
      Remarks Optional. The 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.

      Parameter
      Description
      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 specify OCP Cluster, you can specify the Username and Password parameters, click Search in OBServer next to the ConfigUrl field 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.
      Username Optional. The user reads the incremental logs of OceanBase Database. You must create the user in the sys tenant.
      Password Optional. The password of the user specified by the drc_user parameter.
      _OCEANBASE_INNER_DRC_USER Password Optional. The admin user is used to migrate tables without unique keys in OceanBase Database. 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 or synchronize data from an OceanBase database, you must perform the following operations:

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

        • For the migration of a table without a primary key, specify the password of _OCEANBASE_INNER_DRC_USER.

      • When you create a project to migrate data to an OceanBase database, 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 source, and the validity of the username and password.

    7. After the connection test succeeds, click OK.

    Previous topic

    Data formats
    Last

    Next topic

    Create a DBP data source
    Next
    What is on this page
    Prerequisites
    Procedure