OceanBase logo

OceanBase

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

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

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

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

  • OMS Documentation
  • What's new
  • OMS Community Edition Introduction
    • What is OMS Community Edition?
    • Limits
    • Architecture
      • Overview
      • Hierarchical functional system
      • Basic components
    • Terms
  • Quick Start
    • Data migration process
    • Data synchronization process
  • Deploy OMS Community Edition
    • Deployment type
    • System and network requirements
    • Memory and disk requirements
    • Prepare the environment
    • 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
    • Scale-out and deployment
    • Check the deployment
    • Deploy a time-series database (Optional)
  • OMS Community Edition console
    • Log on to the OMS console
    • Overview
    • User center
      • Configure user information
      • Change your logon password
      • Log off
  • Data migration
    • Data migration overview
    • Migrate data from a MySQL database to OceanBase Community Edition
    • Migrate data from OceanBase Community Edition to a MySQL database
    • Migrate data within OceanBase Community Edition
    • Migrate data within OceanBase Community Edition in active-active disaster recovery scenarios
    • Migrate data from a TiDB database to OceanBase Community Edition
    • Migrate data from a PostgreSQL database to OceanBase Community Edition
    • Manage data migration projects
      • View details of a data migration project
      • View and modify migration objects
      • Use tags to manage data migration projects
      • Download and import the settings of migration objects
      • Start, pause, and resume a data migration project
      • Release and delete a data migration project
    • Schema migration mechanisms
    • Supported DDL operations in incremental migration and limits
      • Supported DDL operations in incremental migration from a MySQL database to OceanBase Community Edition and limits
      • Supported DDL operations in incremental migration from OceanBase Community Edition to a MySQL database and limits
      • Supported DDL operations in incremental migration between MySQL tenants of OceanBase Database
    • Configure matching rules for migration objects
  • Data synchronization
    • Data synchronization overview
    • Create a project to synchronize data from OceanBase Database Community Edition to a Kafka instance
    • Create a project to synchronize data from OceanBase Database Community Edition to a RocketMQ instance
    • Manage data synchronization projects
      • View details of a data synchronization project
      • View and modify synchronization objects
      • Use tags to manage data synchronization projects
      • Download and import the settings of synchronization objects
      • Start, pause, and resume a data synchronization project
      • Release and delete a data synchronization project
    • Data formats
  • Create and manage data sources
    • Create data sources
      • Create an OceanBase-CE data source
      • Create a MySQL data source
      • Create a TiDB data source
      • Create a Kafka data source
      • Create a RocketMQ data source
      • Create a PostgreSQL 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
  • OPS & Monitoring
    • O&M overview
    • Go to the overview page
    • Server
      • View server information
      • Update quotas
      • View server 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 of 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 the information about a checker
        • Start and pause a checker
        • Rerun and reverify a checker
        • Update the configurations of a checker
        • Delete a checker
    • O&M tickets
      • View details of an O\&M ticket
      • Skip a ticket or sub-ticket
      • Retry a ticket or sub-ticket
  • System management
    • Permission Management
      • Overview
      • Manage users
      • Manage departments
    • Alert center
      • View project alerts
      • View system alerts
      • Manage alert settings
    • Associate with OCP
    • System parameters
      • Modify system parameters
      • Modify HA configurations
  • OMS Community Edition O&M
    • Manage OMS services
    • OMS logs
    • O&M operations for the Store component
    • Store parameters
      • Parameters of a MySQL store
      • Parameters of an OceanBase store
    • O&M operations for the Supervisor component
    • Parameters of the Supervisor component
    • O&M operations for the Connector component
    • Connector parameters
      • Parameters of a destination RocketMQ instance
      • Parameters of a DataflowSink instance
      • Parameters in the destination Kafka instance
      • Parameters of the source database in full migration
      • Parameters of the source database in incremental data synchronization
      • Parameters for intermediate-layer synchronization
    • Checker parameters
    • JDBCWriter parameters
    • Parameters of the CM component
  • Reference Guide
    • API Reference
      • Obtain the status of a migration project
      • Obtain the status of a synchronization project
    • OMS error codes
    • 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
  • 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?
    • Project 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
      • 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
        • FAQ about 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 destination table does not exist?
      • Incremental synchronization
        • How do I skip DDL statements?
        • How do I update the configurations of a JDBCWriter?
        • How do I start or stop a JDBCWriter?
        • How do I update whitelists and blacklists?
        • What are the application scope and limits of ETL?
    • Installation and deployment
      • How do I download an image?
      • How do I upgrade Store?

Download PDF

OMS Documentation What's new What is OMS Community Edition? Limits Overview Hierarchical functional system Basic components Terms Data migration process Data synchronization process Deployment type System and network requirements Memory and disk requirements Prepare the environment 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 Scale-out and deployment Check the deployment Deploy a time-series database (Optional) Log on to the OMS console Overview Configure user information Change your logon password Log off Data migration overview Migrate data from a MySQL database to OceanBase Community Edition Migrate data from OceanBase Community Edition to a MySQL database Migrate data within OceanBase Community Edition Migrate data within OceanBase Community Edition in active-active disaster recovery scenarios Migrate data from a TiDB database to OceanBase Community Edition Migrate data from a PostgreSQL database to OceanBase Community Edition View details of a data migration project View and modify migration objects Use tags to manage data migration projects Download and import the settings of migration objects Start, pause, and resume a data migration project Release and delete a data migration project Schema migration mechanisms Supported DDL operations in incremental migration from a MySQL database to OceanBase Community Edition and limits Supported DDL operations in incremental migration from OceanBase Community Edition to a MySQL database and limits Supported DDL operations in incremental migration between MySQL tenants of OceanBase Database Configure matching rules for migration objects Data synchronization overview Create a project to synchronize data from OceanBase Database Community Edition to a Kafka instance Create a project to synchronize data from OceanBase Database Community Edition to a RocketMQ instance View details of a data synchronization project View and modify synchronization objects Use tags to manage data synchronization projects Download and import the settings of synchronization objects Start, pause, and resume a data synchronization project Release and delete a data synchronization project Data formats Create an OceanBase-CE data source Create a MySQL data source Create a TiDB data source Create a Kafka data source Create a RocketMQ data source Create a PostgreSQL data source 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 O&M overview Go to the overview page View server information Update quotas View server logs View details of an O\&M ticket Skip a ticket or sub-ticket Retry a ticket or sub-ticket Overview Manage users Manage departments View project alerts View system alerts Manage alert settings Associate with OCP Modify system parameters Modify HA configurations Manage OMS services OMS logs O&M operations for the Store component Parameters of a MySQL store Parameters of an OceanBase store O&M operations for the Supervisor component Parameters of the Supervisor component O&M operations for the Connector component Parameters of a destination RocketMQ instance Parameters of a DataflowSink instance Parameters in the destination Kafka instance Parameters of the source database in full migration Parameters of the source database in incremental data synchronization Parameters for intermediate-layer synchronization Checker parameters JDBCWriter parameters Parameters of the CM component
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
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.0
iconOceanBase Migration Service
V 4.0.0Community 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.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:2023-06-25 03:29:51  Updated
share
What is on this page
Background
Limits
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 project in OceanBase Migration Service (OMS) Community Edition.

Background

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

Limits

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

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

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

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

  • When synchronizing the data of the IDB logical table to a MySQL tenant of OceanBase Database and DataHub, it only supports adding synchronization objects.

View synchronization objects

  1. Log on to the OMS Community Edition console.

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

  3. On the Data Synchronization page, click the name of the target project 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 project. 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 project, click View Objects in the upper-right corner.

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

  3. In the Add Object dialog box, select the synchronization objects to add in the left-side pane and click > to add the objects to the right-side pane. In the Map Object to Topic dialog box, select a mapping mode as needed.

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

    Notice:

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

  4. Then, click Next.

  5. The system automatically performs a precheck on the added synchronization objects. After the added synchronization 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 synchronization project, you can cancel the addition operation and modify the synchronization objects again. The added synchronization objects will be synchronized to the destination database only after the data synchronization project resumes to normal.

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

    After the object addition 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 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 project vary with the status of the object addition record.

    Note:

    If the original data synchronization project is in the Not Started state, a modification record in the Succeeded state will be generated for an object addition operation. If the original data synchronization project 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 advances only when the original data synchronization project is in the Running state, and the status of the original project changes as the status of the object addition record advances. For details, see the table below.

    Status of an object addition record Supported operations Status of the original project
    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 Causes to jump to the task details page and view the failure causes. Modifying/Integrating

Remove synchronization objects

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

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

  3. In the Remove Objects dialog box, hover the pointer over a synchronization object that you want to remove in the Destination Object section 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 synchronization objects to remove and click OK.

    If the project is in the paused, failed, or running state, after you click OK, the synchronization objects are immediately removed from the destination database.

    Notice:

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

    • The final result of the object removal operation is succeeded or failed for all synchronization 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 project vary with the status of the object removal record.

    Status of an object removal record Supported operations Status of the original project
    Pending View Details and Cancel Running
    Canceled None Running
    Modifying View Details Modifying
    Succeeded View Details Running
    Failed View Details and Retry
    You can also click View Causes to jump to the task details page and view the failure causes.
    Modifying

Previous topic

View details of a data synchronization project
Last

Next topic

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