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.2.11Community Edition

  • OMS Documentation
  • What's New
  • OMS Community Edition Introduction
    • What is OMS Community Edition?
    • Terms
    • OMS Community Edition HA
    • Architecture
      • Hierarchical functional system
      • Overview
      • Basic components
    • Limitations
  • Quick Start
    • Data migration process
    • Data synchronization process
  • Deploy OMS Community Edition
    • Prepare the environment
    • Memory and disk requirements
    • Deployment modes
    • Integrate the OIDC protocol into OMS Community Edition to implement SSO
    • System and network requirements
    • Deploy by using Docker
      • Deploy OMS Community Edition on multiple nodes in a single region
      • Check the deployment
      • Deploy a time-series database (Optional)
      • Deploy OMS Community Edition on a single node
      • Scale out deployment
      • Deploy OMS Community Edition on multiple nodes in multiple regions
    • Deploy by using k8s
      • Single-node deployment
      • Single-region multi-node deployment
      • Multi-region multi-node deployment
      • Scale out
  • OMS Community Edition console
    • Overview
    • Log in to the console of OMS Community Edition
    • User center
      • Change your logon password
      • Log off
      • Configure user information
  • Data migration
    • Overview
    • Migrate data from a MySQL database to OceanBase Database Community Edition
    • Migrate data from HBase to OBKV
    • Migrate incremental data from OBKV to HBase
    • Migrate data from a Milvus database to OceanBase Database Community Edition
    • Migrate data from a Redis database to an OBKV-Redis database
    • Migrate data between tenants of OceanBase Database Community Edition
    • Migrate data in active-active disaster recovery scenarios
    • Migrate data from a TiDB database to OceanBase Database Community Edition
    • Migrate data from a PostgreSQL database to OceanBase Database Community Edition
    • Migrate data from Hive to OceanBase Database Community Edition
    • Migrate data from an ElasticSearch database to OceanBase Database Community Edition
    • Migrate data from OceanBase Database Community Edition to an ElasticSearch database
    • Migrate data from a MongoDB database to OceanBase Database Community Edition
    • Migrate data from a StarRocks database to OceanBase Database Community Edition
    • Migrate data from a Qdrant database to OceanBase Database Community Edition
    • Manage data migration tasks
      • Start and pause a data migration task
      • Manage computing platforms
      • Use tags to manage data migration tasks
      • Download and import settings of migration objects
      • View and modify migration objects
      • Change the name of a data migration task
      • Release and delete a data migration task
      • View details of a data migration task
      • Perform batch operations on data migration tasks
    • Features
      • Rename a database table
      • Schema migration mechanisms
      • Create and update a heartbeat table
      • Direct load
      • Configure matching rules for migration objects
      • DML filtering
      • DDL synchronization
      • Schema migration operations
      • Use SQL conditions to filter data
      • Wildcard rules
      • Set an incremental synchronization timestamp
    • Supported DDL operations in incremental migration and limits
      • DDL synchronization from MySQL database to OceanBase Community Edition
        • Overview of DDL synchronization from a MySQL database to a MySQL-compatible tenant of OceanBase Database
        • CREATE TABLE
          • Create a table
          • Create a column
          • Create an index or a constraint
          • Create partitions
        • Data type conversion
        • ALTER TABLE
          • Modify a table
          • Operations on columns
          • Operations on partitions
          • Operations on constraints and indexes
        • TRUNCATE TABLE
        • RENAME TABLE
        • DROP TABLE
        • CREATE INDEX
        • DROP INDEX
        • DDL incompatibilities between MySQL database and OceanBase Community Edition
          • Overview
          • Incompatibilities of DROP INDEX operations
          • Incompatibilities of the ALTER TABLE statement
            • Delete a constrained column
            • Incompatibilities of ALTER TABLE
            • Change the length of a constrained column
            • Change the type of a constrained column
            • Change the length of an unconstrained column
            • Change the type of an unconstrained column
          • Incompatibilities of the CREATE TABLE statement
            • Incompatibilities of CREATE TABLE
            • Column types that are supported to create indexes or constraints
      • Supported DDL operations in incremental migration between MySQL-compatible tenants of OceanBase Database
      • Synchronize DDL operations from a PostgreSQL database to OceanBase Database
  • Data synchronization
    • Data synchronization overview
    • Create a task to synchronize data from OceanBase Database Community Edition to a Kafka instance
    • Create a task to synchronize data from OceanBase Database Community Edition to a RocketMQ instance
    • Manage data synchronization tasks
      • View details of a data synchronization task
      • Download and import the settings of synchronization objects
      • View and modify synchronization objects
      • Release and delete a data synchronization task
      • Start and pause a data synchronization task
      • Perform batch operations on data synchronization tasks
      • Change the name of a data synchronization task
      • Use tags to manage data synchronization tasks
    • Features
      • DML filtering
      • DDL synchronization
      • Configure matching rules for synchronization objects
      • Rename a topic
      • Use SQL conditions to filter data
      • Column filtering
      • Data format description
  • Create and manage data sources
    • Create data sources
      • Create a Milvus data source
      • Create a RocketMQ data source
      • Create a TiDB data source
      • Create a MongoDB data source
      • Create a PostgreSQL data source
      • Create an HBase data source
      • Create an ElasticSearch data source
      • Create a Kafka data source
      • Create a Qdrant data source
      • Create an OceanBase-CE data source
      • Create a Hive data source
      • Create a Redis data source
      • Create a StarRocks data source
      • Create a MySQL data source
    • Manage data sources
      • Cache system views
      • Copy a data source
      • Delete a data source
      • Edit a data source
      • View data source information
    • Create a database user
    • User privileges
    • Enable binlogs for the MySQL database
  • OPS & Monitoring
    • Go to the overview page
    • O&M overview
    • Components
      • Store
        • Create a Store component
        • Start and pause a Store component
        • Update the configurations of a Store component
        • Delete a Store component
        • View details of a Store component
      • Incr-Sync
        • Update the configurations of an Incr-Sync component
        • View details of an Incr-Sync component
        • Migrate an Incr-Sync component
        • Delete an Incr-Sync component
        • Start and pause an Incr-Sync component
        • Batch O&M
      • Full-Import
        • Rerun and resume a Full-Import component
        • Pause a Full-Import component
        • Delete a Full-Import component
        • View details of a Full-Import component
        • Update the configurations of 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
        • Delete a Full-Verification component
      • Component parameters
        • Parameters of the CM component
        • Parameters of the Full-Verification component
        • Condition
        • Coordinator
        • Parameters of the Supervisor component
        • Sink Plugin
          • HBaseSink
          • JDBC-Sink
          • DatahubSink
          • RocketMQSink
          • KafkaSink
          • HiveSink
          • Overview
        • Source Plugin
          • HBaseSource
          • DataFlowSource
          • KafkaSource (TiDB)
          • ElasticSearchSource
          • MongoDBSource
          • StoreSource
          • Overview
          • LogProxySource
          • HiveSource
        • Store parameters
          • Parameters of a MySQL store
          • Parameters of an OceanBase store
    • Server
      • Update the quota
      • View server logs
      • View server information
    • O&M Task
      • View O&M tasks
      • Skip a task or subtask
      • Retry a task or subtask
  • System management
    • Associate with OCP clusters
    • System parameters
      • Modify HA configurations
      • Modify system parameters
    • Permission Management
      • Overview
      • Manage users
      • Manage departments
    • Alert center
      • Manage alert settings
      • View system alerts
      • View task alerts
  • OMS Community Edition O&M
    • OMS logs
    • Set throttling
    • Manage OMS services
    • 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
      • Full/Incremental data migration performance optimization
  • Reference Guide
    • API Reference
      • StopProject
      • UpdateFullImport
      • Overview
      • ListFullVerifyCorrectionsResult
      • ListProjects
      • CreateMySQLMasterSlaveDataSource
      • DescribeProjectStepMetric
      • ListProjectFullVerifyResult
      • UpdateFullVerification
      • DeleteProject
      • ResumeProject
      • DescribeProject
      • CreateMysqlDataSource
      • CreateOceanBaseDataSource
      • CreateLabel
      • ListAllLabels
      • UpdateIncrSync
      • DescribeProjectSteps
      • ListDataSource
      • ListFullVerifyInconsistenciesResult
      • StartProjectsByLabel
      • ReleaseProject
      • StartProject
      • DescribeProjectProgress
      • StopProjectsByLabel
      • DescribeProjectComponents
      • CreateProject
      • UpdateStore
    • OMS error codes
    • Alert Reference
      • oms_host_down_migrate_resource
      • oms_sync_status_inconsistent
      • oms_host_threshold
      • oms_migration_delay
      • oms_host_down
      • oms_sync_delay
      • oms_migration_failed
      • oms_sync_failed
    • Telemetry parameters
    • Create a trigger
  • Upgrade Guide
    • Overview
    • Upgrade in single-node deployment mode
    • Upgrade in multi-node deployment mode
    • Hot upgrade OMS Community Edition
    • FAQ
    • Upgrade the CDC library
  • FAQ
    • General O&M
      • Clear files in the Store component
      • Deploy InfluxDB for OMS
      • Increase the disk space of the OMS host
      • How do I modify the resource quotas of an OMS container?
      • How do I troubleshoot the OMS server down issue?
    • Task diagnostics
      • 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?
    • OPS & monitoring
      • What are the alert rules?
    • Data synchronization
      • Performance troubleshooting and tuning for data synchronization from OceanBase Community Edition to Kafka
      • FAQ about synchronization to a message queue
        • What are the strategies for ensuring the message order in incremental data synchronization to Kafka
    • Data migration
      • Full migration
        • How do I query the ID of a checker?
        • How do I query log files of the Checker component of OMS?
        • What do I do if garbled characters cannot be written into OceanBase Database V3.1.2?
        • What can I do when the full migration failed due to LOB fields?
        • What do I do if the target table does not exist?
        • Garbled characters in the Latin1 character set
        • How do I query the verification result files of the Checker component of OMS?
      • Incremental synchronization
        • How do I skip DDL statements?
        • How do I update whitelists and blacklists?
        • What are the application scope and limits of ETL?
    • Logon and password
      • What do I do if my logon password is locked?
    • Installation and deployment
      • What do I do when the "Failed to fetch" error is reported?
      • Change port numbers for components
      • Switching between the primary and standby OMS MetaDBs
      • How do I upgrade Store?

Download PDF

OMS Documentation What's New What is OMS Community Edition? Terms OMS Community Edition HA Hierarchical functional system Overview Basic components Limitations Data migration process Data synchronization process Prepare the environment Memory and disk requirements Deployment modes Integrate the OIDC protocol into OMS Community Edition to implement SSO System and network requirements Deploy OMS Community Edition on multiple nodes in a single region Check the deployment Deploy a time-series database (Optional) Deploy OMS Community Edition on a single node Scale out deployment Deploy OMS Community Edition on multiple nodes in multiple regions Single-node deployment Single-region multi-node deployment Multi-region multi-node deployment Scale out Overview Log in to the console of OMS Community Edition Change your logon password Log off Configure user information Overview Migrate data from a MySQL database to OceanBase Database Community Edition Migrate data from HBase to OBKV Migrate incremental data from OBKV to HBase Migrate data from a Milvus database to OceanBase Database Community Edition Migrate data from a Redis database to an OBKV-Redis database Migrate data between tenants of OceanBase Database Community Edition Migrate data in active-active disaster recovery scenarios Migrate data from a TiDB database to OceanBase Database Community Edition Migrate data from a PostgreSQL database to OceanBase Database Community Edition Migrate data from Hive to OceanBase Database Community Edition Migrate data from an ElasticSearch database to OceanBase Database Community Edition Migrate data from OceanBase Database Community Edition to an ElasticSearch database Migrate data from a MongoDB database to OceanBase Database Community Edition Migrate data from a StarRocks database to OceanBase Database Community Edition Migrate data from a Qdrant database to OceanBase Database Community Edition Start and pause a data migration task Manage computing platforms Use tags to manage data migration tasks Download and import settings of migration objects View and modify migration objects Change the name of a data migration task Release and delete a data migration task View details of a data migration task Perform batch operations on data migration tasks Rename a database table Schema migration mechanisms Create and update a heartbeat table Direct load Configure matching rules for migration objects DML filtering DDL synchronization Schema migration operations Use SQL conditions to filter data Wildcard rules Set an incremental synchronization timestamp Supported DDL operations in incremental migration between MySQL-compatible tenants of OceanBase Database Synchronize DDL operations from a PostgreSQL database to OceanBase Database Data synchronization overview Create a task to synchronize data from OceanBase Database Community Edition to a Kafka instance Create a task to synchronize data from OceanBase Database Community Edition to a RocketMQ instance View details of a data synchronization task Download and import the settings of synchronization objects View and modify synchronization objects Release and delete a data synchronization task Start and pause a data synchronization task Perform batch operations on data synchronization tasks Change the name of a data synchronization task Use tags to manage data synchronization tasks DML filtering DDL synchronization Configure matching rules for synchronization objects Rename a topic Use SQL conditions to filter data Column filtering Data format description Create a Milvus data source Create a RocketMQ data source Create a TiDB data source Create a MongoDB data source Create a PostgreSQL data source Create an HBase data source Create an ElasticSearch data source Create a Kafka data source Create a Qdrant data source Create an OceanBase-CE data source Create a Hive data source Create a Redis data source Create a StarRocks data source
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.2.11
iconOceanBase Migration Service
V 4.2.11Community 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

View and modify synchronization objects

Last Updated:2026-04-14 07:36:10  Updated
Share
What is on this page
Background
Limitations
View synchronization objects
Add synchronization objects
Remove synchronization objects

folded

Share

This topic describes how to view and modify the synchronization objects of a data synchronization task in OceanBase Migration Service (OMS).

Background

If the limits are met, you can add or remove synchronization objects during synchronization. The changes made during the running of the task will be recorded. After an object addition task is completed, it will be integrated with the original task that is associated. After the task is integrated with the original task, the original task runs normally and the object addition task is automatically released.

Limitations

  • For a data synchronization task in the Not Started, Running, or Paused state, you can add or remove its synchronization objects.

  • For a data synchronization task in the Failed state, you can only remove its synchronization objects.

  • For a data synchronization task in the Modifying or Integrating state, you cannot modify its synchronization objects again.

  • When the Incremental Synchronization step of a data synchronization task is in the Paused or Failed state, you can only remove its synchronization objects.

  • When you synchronize data from an IDB logical table to a MySQL-compatible tenant of OceanBase Database or to a DataHub instance, you can only add synchronization objects.

View synchronization objects

  1. Log in to the OMS console.

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

  3. On the Data Synchronization page, click the name of the target task to go to its details page.

  4. Click View Objects in the upper-right corner and view information on the Synchronization Objects and Object Modifications tabs.

    • The Synchronization Objects tab displays the synchronization objects of the current task. You can click Modify Object and then select Add Object or Remove Objects.

    • The Object Modifications tab displays the IDs, types, statuses, and occurrence time of all object modifications.

Add synchronization objects

  1. On the details page of the target task, click View Objects in the upper-right corner.

  2. In the View Objects dialog box, choose Modify Objects > Add Objects.

  3. In the Add Objects dialog box that appears, select the objects to be synchronized in the left-side pane and click >. In the Map Object to Topic dialog box that appears, select a mapping method.

    After you select the synchronization objects to add, you can perform operations such as changing the topic and setting row filters.

    Notice

    By default, the newly added synchronization objects will inherit all configuration options of the original data synchronization task. If you abort the object addition operation, you must manually delete the objects that have been added to the target database.

  4. Then, click Next.

  5. The system automatically performs a precheck on the added migration objects. After the added migration objects pass all check items, click Save.

  6. Confirm the information and click OK in the dialog box that appears.

    • For a paused or failed data migration task, you can cancel the operation and modify the migration objects again. The added migration objects will be migrated to the target database only after the data migration task returns to normal.

    • If you add synchronization objects for a running data synchronization task, after you click Save, the added synchronization objects will be immediately synchronized to the target database.

    After the object addition operation begins, records will be generated on the page that appears after you choose View Objects > Object Modifications. You can view details of the records on this page. The status of object addition records can be Pending, Canceled, Modifying, Running, Aborted, Integrating, Succeeded, or Failed. The operations that you can perform on an object addition record and the status of the original task vary with the status of the object addition record.

    Description

    If the original data synchronization task is in the Not Started state, a modification record in the Successful state will be generated for an object addition operation. If the original data synchronization task is in the Paused state, a modification record in the Pending state will be generated for an object addition operation.

    The status of an object addition record changes only when the original data synchronization task is in the Running state, and the status of the original task changes along with the status of the object addition record. The following table describes more information.

    Status of an object addition record
    Supported operations
    Status of the original task
    Pending View details and cancel. Running
    Canceled None Running
    Modifying None Modifying
    Running View details and abort. Modifying
    Aborted View details. Running
    Integrating View details. Integrating
    Succeeded View details. Running
    Failed View details and retry.
    You can also click View Cause to go to the details page of the task and view the cause of the failure.
    Modifying/Integrating

Remove synchronization objects

  1. On the details page of the target task, click View Objects in the upper-right corner.

  2. In the View Objects dialog box, choose Modify Objects > Remove Objects.

  3. In the Remove Objects dialog box, move the pointer over a migration object that you want to remove in the Target Object section on the right and click Remove.

    You can select multiple synchronization objects and then click Batch Remove. In the dialog box that appears, click OK.

  4. In the Remove Objects dialog box, click Remove.

  5. In the confirmation dialog box that appears, confirm the migration object to remove and click OK.

    If the task is in the paused, failed, or running state, after you click OK, the migration object is immediately removed from the target database.

    Notice

    • A removed migration object cannot be recovered, so proceed with caution.

    • The final result of the object removal operation is either succeeded or failed for all migration objects.

    After the object removal operation begins, records will be generated on the page displayed after you choose View Objects > Object Modifications. You can view the details of the records on this page. The status of object removal records can be Pending, Canceled, Modifying, Succeeded, or Failed. The operations that you can perform on an object removal record and the status of the original task vary with the status of the object removal record.

    Status of an object removal record
    Supported operations
    Status of the original task
    Pending View details and cancel. Running
    Canceled None Running
    Modifying None Modifying
    Succeeded View details. Running
    Failed View details and retry.
    You can also click View Cause to go to the details page of the task and view the cause of the failure.
    Modifying

Previous topic

Change the name of a data synchronization task
Last

Next topic

Use tags to manage data synchronization tasks
Next
What is on this page
Background
Limitations
View synchronization objects
Add synchronization objects
Remove synchronization objects