OceanBase Migration Service

V4.3.1Enterprise Edition

OMS Documentation
OMS Introduction
- Overview of OMS
- Terms
- OMS HA
- Principles of Store
- Principles of Full-Import and Incr-Sync
- Data verification principles
- Architecture
  - Overview
  - Hierarchical functional system
  - Basic components
- OMS Oracle full migration design and impact
- Limitations
Quick Start
- Data migration process
- Data synchronization process
Deploy OMS
- Deployment types
- System and network requirements
- Memory and disk requirements
- Environment preparations
- Deploy OMS on a single node
- Deploy OMS on multiple nodes in a single region
- Deploy OMS on multiple nodes in multiple regions
- Scale out
- Scale down deployment
- Check the deployment
- Deploy a time-series database (Optional)
OMS console
- Log in to the OMS console
- Overview
- User center
  - Configure user information
  - Change your login password
  - Log out
Data migration
- Overview
- Migrate data from a MySQL database to a MySQL-compatible tenant of OceanBase Database
- Migrate data from a MySQL-compatible tenant of OceanBase Database to a MySQL database
- Migrate data from an Oracle database to the MySQL compatible mode of OceanBase Database
- Migrate data from the Oracle compatible mode of OceanBase Database to an Oracle database
- Migrate data from an Oracle database to the Oracle compatible mode of OceanBase Database
- Migrate data from a DB2 LUW database to an Oracle-compatible tenant of OceanBase Database
- Migrate data from an Oracle-compatible tenant of OceanBase Database to a DB2 LUW database
- Migrate data from a DB2 LUW database to a MySQL-compatible tenant of OceanBase Database
- Migrate data from a MySQL-compatible tenant of OceanBase Database to a DB2 LUW database
- Migrate data between OceanBase databases of the same tenant type
- Configure a bidirectional synchronization task
- Migrate data from a TiDB database to a MySQL-compatible tenant of OceanBase Database
- Migrate data from a PostgreSQL database to the Oracle compatible mode of OceanBase Database
- Migrate data from a PostgreSQL database to the MySQL compatible mode of OceanBase Database
- Migrate data from a PolarDB-X 1.0 database to a MySQL-compatible tenant of OceanBase Database
- Migrate incremental data from an Oracle-compatible tenant of OceanBase Database to a MySQL database
- Manage data migration tasks
  - View details of a data migration task
  - Rename a data migration task
  - View and modify migration objects
  - Use tags to Manage data migration tasks
  - Perform batch operations on data migration tasks
  - Download and import settings of migration objects
  - View and modify migration parameters
  - Download a conflict log file
  - Start and pause a data migration task
  - End and delete a data migration task
- Supported DDL operations and limits for synchronization
  - Synchronize DDL operations from a MySQL database to a MySQL-compatible tenant of OceanBase Database
    - Overview of DDL synchronization from MySQL to OceanBase Database's MySQL compatible mode
    - CREATE TABLE
      - Create a table
      - Create a column
      - Create indexes or constraints
      - Create partitions
    - Data type conversion
    - ALTER TABLE
      - Modify tables
      - Operations on columns
      - Operations on constraints and indexes
      - Partition operations
    - TRUNCATE TABLE
    - RENAME TABLE
    - DROP TABLE
    - CREATE INDEX
    - DROP INDEX
    - DDL incompatibilities between a MySQL database and a MySQL-compatible tenant of OceanBase Database
      - Overview
      - Incompatibilities of the CREATE TABLE statement
        Incompatibilities of CREATE TABLE
        Column types that are supported to create indexes or constraints
      - Incompatibilities of the ALTER TABLE statement
        Incompatibilities of ALTER TABLE
        Change the type of a constrained column
        Change the type of an unconstrained column
        Change the length of a constrained column
        Change the length of an unconstrained column
        Delete a constrained column
      - Incompatibilities of DROP INDEX operations
  - Synchronize DDL operations from the MySQL compatible mode of OceanBase Database to a MySQL database
  - DDL operations for synchronizing data from an Oracle database to an Oracle-compatible tenant of OceanBase Database
    - Overview of DDL synchronization from Oracle to OceanBase Database Oracle compatible mode
    - CREATE TABLE
      - Overview for CREATE TABLE
      - Create a relational table
        Create a relational table
        Define columns of a relational table
      - Virtual columns
      - Regular columns
      - Create partitions
        Overview for creating partitions
        Partitioning
        Subpartitioning
        Composite partitioning
        User-defined partitioning
        Subpartition templates
      - Constraints
        Overview
        Inline constraints
        Out-of-line constraints
    - CREATE INDEX
      - Overview
      - Oracle compatible mode
    - ALTER TABLE
      - Overview
      - Modify, drop, and add table attributes
      - Column attribute management
        Modify, drop, and add column attributes
        Rename a column
        Add columns and column attributes
        Modify column attributes
        Drop columns
      - Modify, drop, and add constraints
      - Partition management
        Modify, drop, and add partitions
        Drop a partition
        Drop a subpartition
        Add partitions and subpartitions
        Modify partitions
        Drop partition data
    - DROP TABLE
    - RENAME OBJECT
    - TRUNCATE TABLE
    - DROP INDEX
    - DDL incompatibilities between an Oracle database and an Oracle-compatible tenant of OceanBase Database
      - Overview
      - Incompatibilities of CREATE TABLE
      - Incompatibilities in table modification operations
        Incompatibilities of ALTER TABLE
        Change the type of a constrained column
        Change the type of an unconstrained column
        Change the length of a constrained column
        Change the length of an unconstrained column
  - Synchronize DDL operations from the Oracle compatible mode of OceanBase Database to an Oracle database
  - Synchronize DDL operations from a DB2 LUW database to an Oracle-compatible tenant of OceanBase Database
  - Synchronize DDL operations from the Oracle compatible mode of OceanBase Database to a DB2 LUW database
  - Synchronize DDL operations from a DB2 LUW database to a MySQL-compatible tenant of OceanBase Database
  - Synchronize DDL operations from the MySQL compatible mode of OceanBase Database to a DB2 LUW database
  - Synchronize DDL operations between MySQL-compatible tenants of OceanBase Database
  - DDL synchronization between Oracle-compatible tenants of OceanBase Database
  - DDL operations for synchronizing data from a PostgreSQL database to the MySQL compatible mode of OceanBase Database
  - DDL synchronization from PostgreSQL to OceanBase Database in Oracle compatible mode
Data synchronization
- Overview
- Synchronize data from OceanBase Database to a Kafka instance
- Synchronize data from OceanBase Database to a RocketMQ instance
- Synchronize data from OceanBase Database to a DataHub instance
- Synchronize data from an ODP logical table to a physical table in a MySQL-compatible tenant of OceanBase Database
- Synchronize data from an ODP logical table to a DataHub instance
- Synchronize data from an IDB logical table to a MySQL-compatible tenant of OceanBase Database
- Synchronize data from an IDB logical table to a DataHub instance
- Synchronize data from a MySQL database to a DataHub instance
- Synchronize data from an Oracle database to a DataHub instance
- Manage data synchronization tasks
  - View details of a data synchronization task
  - Change the name of a data synchronization task
  - View and modify synchronization objects
  - Use tags to Manage data synchronization tasks
  - Perform batch operations on data synchronization tasks
  - Download and import the settings of synchronization objects
  - View and modify the parameter configurations of a data synchronization task
  - Start and pause a data synchronization task
  - End and delete a data synchronization task
Data validation
- Overview
- Create a data validation task
- Manage data validation tasks
  - View details of a data validation task
  - Change the name of a data validation task
  - View and modify validation objects
  - View and modify validation parameters
  - Manage data validation tasks by using tags
  - Import validation objects
  - Start, stop, and resume a data validation task
  - Clone a data validation task
  - Delete a data validation task
Create and manage data sources
- Create data sources
  - Create an OceanBase data source
    - Create a physical OceanBase data source
    - Create an ODP data source
    - Create an IDB data source
    - Create a public cloud OceanBase data source
    - Create a standalone OceanBase data source
  - Create a MySQL data source
  - Create an Oracle data source
  - Create a TiDB data source
  - Create a Kafka data source
  - Create a RocketMQ data source
  - Create a DataHub data source
  - Create a DB2 LUW data source
  - Create a PostgreSQL data source
  - Create a PolarDB-X 1.0 data source
- Manage data sources
  - View data source information
  - Copy a data source
  - Edit a data source
  - Delete a data source
- Create a database user
- User privileges
- Enable binlogs for the MySQL database
- Minimum privileges required when an Oracle database serves as the source
OPS & Monitoring
- O&M overview
- Go to the overview page
- Server
  - View server information
  - Update the quota
  - View server logs
  - Manage resource groups
- Components
  - Store
    - Add a Store component
    - View details of a Store component
    - Update the configurations of a Store component
    - Start and pause a Store component
    - Delete a Store component
  - Incr-Sync
    - View details of an Incr-Sync component
    - Start and pause an Incr-Sync component
    - Migrate an Incr-Sync component
    - Update the configurations of an Incr-Sync component
    - Batch O&M
    - Delete an Incr-Sync component
  - Full-Import
    - View details of a Full-Import component
    - Pause a Full-Import component
    - Rerun and resume a Full-Import component
    - Update the configurations of a Full-Import component
    - Delete a Full-Import component
  - Full-Verification
    - View details of a Full-Verification component
    - Pause a Full-Verification component
    - Rerun and resume a Full-Verification component
    - Update the configurations of a Full-Verification component
  - Incr-Verification
    - View details of the Incr-Verification component
    - Pause an Incr-Verification component
    - Rerun and resume an Incr-Verification component
    - Update an Incr-Verification component
  - Row-Verification
    - View details of a Row-Verification component
- O&M Task
  - View O&M tasks
  - Skip a task or subtask
  - Retry a task or subtask
- Parameter Template
  - Overview
  - Task Template
    - Create a task template
    - View and edit task templates
    - Copy and export a task template
    - Delete a task template
  - Component Template
    - Create a component template
    - View and edit component templates
    - Copy and export a component template
    - Delete a component template
  - Component parameters
    - Store component parameters
    - Incr-Sync component parameters
    - Full-Import component parameters
    - Full-Verification component parameters
    - Incr-Verification component parameters
    - Parameters of the Row-Verification component
    - CM component parameters
    - Supervisor component parameters
System management
- Permission Management
  - Overview
  - Manage users
  - Manage departments
- Alert center
  - View task alerts
  - View system alerts
  - Manage alert settings
- Associate with OCP
- System parameters
  - Modify system parameters
  - Modify HA configurations
  - oblogproxy parameters
- Manage access keys
- Operation audit
Troubleshooting Guide
- Manage OMS services
- OMS logs
- Component O&M
  - O&M operations for the Supervisor component
  - CLI-based O&M for the Connector component
  - O&M operations for the Store component
- Component tuning
  - Incr-Sync/Full-Import tuning
  - Oracle store tuning
- Set throttling
- Store performance diagnostics
Reference Guide
- Features
  - Configure DDL/DML synchronization
  - DDL synchronization scope
  - Rename databases and tables
  - Use SQL conditions to filter data
  - Set the incremental synchronization start timestamp
  - Configure matching rules for migration or synchronization objects
  - Configure matching rules for validation objects
  - Wildcard patterns supported for matching rules
  - Hidden column mechanisms
  - Instructions on schema migration
  - Create and update a heartbeat table
  - Change a topic
  - Column filtering
  - Data formats
- API Reference
  - Overview
  - CreateProject
  - StartProject
  - StopProject
  - ResumeProject
  - ReleaseProject
  - DeleteProject
  - ListProjects
  - DescribeProject
  - DescribeProjectSteps
  - DescribeProjectStepMetric
  - DescribeProjectProgress
  - DescribeProjectComponents
  - ListProjectFullVerifyResult
  - StartProjectsByLabel
  - StopProjectsByLabel
  - CreateMysqlDataSource
  - CreateOceanBaseDataSource
  - CreateOceanBaseODPDataSource
  - CreatePolarDBDataSource
  - ListDataSource
  - CreateLabel
  - ListAllLabels
  - DeleteDataSource
  - CreateProjectModifyRecords
  - ListProjectModifyRecords
  - StopProjectModifyRecords
  - RetryProjectModifyRecords
  - CancelProjectModifyRecord
  - SubmitPreCheck
  - GetPreCheckResult
  - UpdateProjectConfig
  - Download schema conversion information
  - DownloadConflictData
  - ListConflictData
  - ResetIncrStartTimestamp
  - AdvanceProject
  - DescribeRegions
- 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
- SSO
  - Integrate the OIDC protocol to OMS to implement SSO
  - Integrate the SAML 2.0 protocol to OMS to implement SSO
  - Access Microsoft Entra ID using OMS SAML 2.0
- OMS error codes
- SQL statements for querying table objects
- Create a trigger
- Change the log level for a PostgreSQL instance
- Online DDL tools
- Supplemental logging in Oracle databases
Upgrade Guide
- Overview
- Upgrade OMS in single-node deployment mode
- Upgrade OMS in multi-node deployment mode
- FAQ
FAQ
- General O&M
  - How do I modify the resource quotas of an OMS container?
  - How do I troubleshoot the OMS server down issue?
  - Deploy InfluxDB for OMS
  - Increase the disk space of the OMS host
- Task diagnostics
  - How do I troubleshoot common problems with Oracle Store?
  - How do I perform performance tuning for Oracle Store?
  - What do I do when Oracle Store reports an error at the isUpdatePK stack?
  - What do I do when a store does not have data of the timestamp requested by the downstream?
  - What do I do when OceanBase Store failed to access an OceanBase cluster through RPC?
  - How do I use LogMiner to pull data from an Oracle database?
- OPS & monitoring
  - What are the alert rules?
- Data synchronization
  - FAQ about synchronization to a message queue
    - What are the strategies for ensuring the message order in incremental data synchronization to Kafka
- Data migration
  - User privileges
    - What privileges do I need to grant to a user during data migration to or from an Oracle database?
  - Full migration
    - How do I query the ID of a checker?
    - How do I query log files of the Checker component of OMS?
    - How do I query the verification result files of the Checker component of OMS?
    - What do I do if the target table does not exist?
    - What can I do when the full migration failed due to LOB fields?
    - What do I do if garbled characters cannot be written into OceanBase Database V3.1.2?
  - Incremental synchronization
    - How do I skip DDL statements?
    - How do I migrate an Oracle database object whose name exceeds 30 bytes in length?
    - How do I update whitelists and blacklists?
    - What are the application scope and limits of ETL?
- Installation and deployment
  - How do I upgrade Store?
Release Note
- Release Note
  - Version number rules
  - V4.3
    - OMS V4.3.1
    - OMS V4.3.0
  - V4.2
    - OMS V4.2.5
    - OMS V4.2.4
    - OMS V4.2.3
    - OMS V4.2.2
    - OMS V4.2.1
    - OMS V4.2.0
  - V4.1
    - OMS V4.1.0
  - V4.0
    - OMS V4.0.2
    - OMS V4.0.1
  - V3.4
    - OMS V3.4.0
  - V3.3
    - OMS V3.3.1
    - OMS V3.3.0
  - V3.2
    - OMS V3.2.2
    - OMS V3.2.1
  - V3.1
    - OMS V3.1.0
  - V2.1
    - OMS V2.1.2
    - OMS V2.1.0

Download PDF

OceanBase, A Highly Scalable Database for Transactional, Analytical, and AI Workloads.

Company

About OceanBase Contact Us Partner

Product

OceanBase Cloud OceanBase Enterprise Quick Start Download Pricing

Resources

Docs Blog White Paper Trust Center

Document Feedback

Limitations

Last Updated：2025-10-21 10:56:45 Updated

This topic describes the limitations on data migration and data synchronization by using OceanBase Migration Service (OMS).

Supported OceanBase Database versions

The versions of OceanBase Database that support data migration and data synchronization are as follows:

Versions of OceanBase Database earlier than V4.x are supported as the source to pull full data and incremental data and as the target to write data.
OceanBase Database V4.x is supported as the source to pull full data and as the target to write data.
For incremental data synchronization of OceanBase Database V4.x, the following versions are supported. Synchronization for other versions will be supported after the store version is hot-upgraded.
- V4.1.x
- V4.2.1.11, V4.2.2.1, V4.2.3.0, V4.2.4.0, V4.2.5.6, V4.3.0.1, V4.3.1.0, V4.3.2.1, V4.3.3.1, V4.3.4.1, V4.3.5.4, and V4.4.0.1

The following table describes the versions of other databases and OceanBase Cloud Platform (OCP) that support data migration and data synchronization.

Data transmission feature	Other database versions	OCP versions
Data migration	MySQL: V5.5, V5.6, V5.7, V8.0 MariaDB: V10.2, V10.6.x DB2 LUW: V9.7, V10.1, V10.5, V11.1, V11.5 Oracle: 10G/11G/12c/18c/19c (CDBs and PDBs are supported in Oracle Database 12c and later versions) PostgreSQL: V10.x, V11.x, V12.x, V13.x, V14.x, V15.x TiDB: V4.x, V5.4, V6.x, V7.x	V2.x: V2.3.9, V2.4.5, V2.5.0 V3.x V4.x
Data synchronization	Kafka: V0.9, V1.0, V2.x, V3.x RocketMQ: V4.x, V5.x MySQL: V5.5, V5.6, V5.7, V8.0 Oracle: 10G/11G/12c/18c/19c (CDBs and PDBs are supported in Oracle Database 12c and later versions) DataHub: not involved	V2.x: V2.3.9, V2.4.5, V2.5.0 V3.x V4.x

Supported system architectures

OMS supports the x86 and ARM architectures.

Notice

The ARM architecture has the following limitations:

Incremental synchronization from a DB2 LUW database to the Oracle compatible mode of OceanBase Database
Incremental synchronization from the Oracle compatible mode of OceanBase Database to a DB2 LUW database
Incremental synchronization from a DB2 LUW database to the MySQL compatible mode of OceanBase Database
Incremental synchronization from the MySQL compatible mode of OceanBase Database to a DB2 LUW database

Previous topic

OMS Oracle full migration design and impact

Last

Next topic

Data migration process