OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Migration Service

V3.3.1Community Edition
  • Product updates
  • Product Introduction
    • What is OMS Community Edition?
    • Architecture
      • Overview
      • Hierarchical functional system
      • Basic components
    • Limits
    • Terms
  • Deployment Guide
    • Overview
    • System requirements
    • Resource configuration specifications
    • Prepare the environment
    • Deploy a time-series database (Optional)
    • Deploy OMS Community Edition on a single node
    • Deploy OMS Community Edition on multiple nodes in a single region
    • Deploy OMS Community Edition on multiple nodes in multiple regions
    • Check the deployment
    • Scale out OMS Community Edition
  • User Guide
    • OMS Community Edition console
      • Log on to the OMS Community Edition console
      • Overview
      • User center
        • Configure user information
        • Change your logon password
        • Log off
    • Users and privileges
      • Create a database user
      • User privileges
      • Enable binlogs for the MySQL database
    • Manage data sources
      • Add a data source
        • Add an OceanBase Community Edition data source
        • Add a MySQL data source
        • Add a TiDB data source
        • Add a Kafka data source
        • Add a RocketMQ data source
      • View data source information
      • Copy a data source
      • Edit a data source
      • Delete a data source
    • Data migration
      • Overview
      • Supported DDL operations for incremental migration and limits
      • Create a data migration project
        • Create a project to migrate data from a MySQL database to OceanBase database Community Edition
        • Create a project to migrate data from OceanBase database Community Edition to a MySQL database
        • Migrate data within OceanBase database Community Edition
        • Create an active-active disaster recovery project in OceanBase database Community Edition
        • Create a project to migrate data from a TiDB database to OceanBase database Community Edition
      • Manage data migration projects
        • View details of a data migration project
        • Start, pause, and resume a data migration project
        • Release a data migration project
        • Delete a data migration project
        • Use tags to manage data migration projects
        • Download and import the settings of migration objects
      • Configure matching rules for migration objects
    • Data synchronization
      • Overview
      • Data formats
      • Create a data synchronization project
        • Create a project to synchronize data from an OceanBase database Community Edition to a Kafka instance
        • Create a project to synchronize data from an OceanBase database Community Edition to a RocketMQ instance
      • Manage data synchronization projects
        • View details of a data synchronization project
        • Start, pause, and resume a data synchronization project
        • Release and delete a data synchronization project
        • Use tags to manage data synchronization projects
        • Download and import the settings of synchronization objects
    • OPS & Monitoring
      • Go to the overview page
      • Server
        • View server information
        • Update the quota
        • View server logs
        • Paths of component logs
      • Components
        • Store
          • Create a store
          • View details of a store
          • Update the configurations of a store
          • Start and pause a store
          • Destroy a store
        • Connector
          • View details about a connector
          • Start and pause a connector
          • Migrate a connector
          • Update the configurations of a connector
          • Batch O&M
          • Delete a connector
        • JDBCWriter
          • View details of a JDBCWriter
          • Start and pause a JDBCWriter
          • Migrate a JDBCWriter
          • Update the configurations of a JDBCWriter
          • Batch O&M
          • Delete a JDBCWriter
        • Checker
          • View details of a checker
          • Start and pause a checker
          • Rerun and recover a checker
          • Update the configurations of a checker
          • Delete a checker
      • O&M ticket
        • View details of an O&M ticket
        • Skip a ticket or sub-ticket
        • Retry a ticket or sub-ticket
      • Component parameters
        • Store parameters
          • Parameters of a MySQL store
          • Parameters of an OceanBase store
        • Connector parameters
          • Parameters of a destination RocketMQ instance
          • Parameters of a DataflowSink instance
          • Parameters of a destination Kafka instance
          • Parameters of a source database in full migration
          • Parameters for intermediate-layer synchronization
        • JDBCWriter parameters
        • Checker parameters
    • System management
      • User management
      • Alert center
        • View project alerts
        • View system alerts
        • Manage alert settings
      • Associate with OCP
      • System Parameters
        • Modify system parameters
        • Modify HA configurations
  • Alert Reference
    • oms_host_down
    • oms_host_down_migrate_resource
    • oms_host_threshold
    • oms_migration_failed
    • oms_migration_delay
    • oms_sync_failed
    • oms_sync_status_inconsistent
    • oms_sync_delay
  • API Reference
    • Obtain the status of a migration project
    • Obtain the status of a synchronization project
  • Upgrade Guide
    • Overview
    • Upgrade OMS Community Edition in single-node deployment mode
    • Upgrade OMS Community Edition in multi-node deployment mode
    • FAQ

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Migration Service
  3. V3.3.1

Add a MySQL data source

Last Updated:2026-09-04 08:14:02

Prerequisites
Limits
Procedure

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

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 User privileges.

Limits

OMS supports the following MySQL database versions: 5.5, 5.6, 5.7, and 8.0.

Procedure

  1. Log on to the console of OMS Community Edition.

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

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

  4. In the Add Data Source dialog box, select MySQL for Data Source Type.

  5. Specify the following parameters.

    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.
    Database Attributes Database attributes include Primary Database, Primary Database + Standby Database, and Standby Database. When you configure the primary database, you can choose whether to select the following option: Allow OMS to automatically write incremental heartbeat data to the instance during incremental synchronization.
    • If you select this option, OMS Community Edition creates the drc.heartbeat table in the MySQL database and updates the table to accelerate the store startup. This prevents OMS from displaying lengthy latency information when the source database is not processing business traffic.
      Notice:
      The MySQL database user must have the privileges to create and write tables. For more information, see User privileges.
    • If you do not select this option, OMS Community Edition does not create the drc.heartbeat table.
    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.
    Username The name of the MySQL database user created for data migration.
    Password The password of the MySQL database user.
    Database Name Optional. The name of the MySQL database.
    Remarks (Optional) Additional information about the data source.
  6. Click Test Connection to verify the network connection between OMS Community Edition and the data source, as well as the validity of the username and password. You can specify a database as the source or destination.

  7. After the connection test is passed, click Add.

Previous topic

Add an OceanBase Community Edition data source
Last

Next topic

Add a TiDB data source
Next
on this page
Prerequisites
Limits
Procedure