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 Cloud

OceanBase Database

Tools Connectors and Middleware

QUICK START

OceanBase Cloud OceanBase 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

Document Feedback

Parameters of a destination RocketMQ instance

Last Updated：2026-04-14 07:36:28 Updated

Parameter	Type	Required	Default value	Description
accessKey	String	No	None	The access key for Alibaba Cloud.
nameSvrAddr	String	Yes	None	The connection information of the RocketMQ instance.
producerGroup	String	No	None	The producer group.
secretKey	String	No	None	The access key for Alibaba Cloud.
shardFields	String	No	None	The fields for sharding.
tag	String	No	None	The RocketMQ message tag.
topic	String	Yes	None	The RocketMQ topic.

Previous topic

O&M operations for the Connector component

Last

Next topic

Parameters of a DataflowSink instance

OceanBase Migration Service

V3.4.0Enterprise Edition

OMS Documentation
What's new
OMS Introduction
- What is OMS?
- Terms
- Architecture
  - Overview
  - Hierarchical functional system
  - Basic components
- Limits
Quick Start
- Data migration process
- Data synchronization process
Deployment Guide
- Deployment type
- System and network requirements
- Memory and disk requirements
- Prepare the environment
- 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 and deployment
- Check the deployment
- Deploy a time-series database (Optional)
OMS console
- Log on to the OMS console
- Overview
- User center
  - Configure user information
  - Change your logon password
  - Log off
Data migration
- Data migration overview
- Create a project to migrate data from a MySQL database to a MySQL tenant of OceanBase Database
- Create a project to migrate data from a MySQL tenant of OceanBase Database to a MySQL database
- Create a project to migrate data from an Oracle database to a MySQL tenant of OceanBase Database
- Create a project to migrate data from an Oracle tenant of OceanBase Database to an Oracle database
- Create a project to migrate data from an Oracle database to an Oracle tenant of OceanBase Database
- Create a project to migrate data from a DB2 LUW database to an Oracle tenant of OceanBase Database
- Create a project to migrate data from an Oracle tenant of OceanBase Database to a DB2 LUW database
- Create a project to migrate data from a DB2 LUW database to an OceanBase database in MySQL tenant mode
- Create a project to migrate data from a MySQL tenant of OceanBase Database to a DB2 LUW database
- Migrate data within OceanBase Database
- Create an active-active disaster recovery project in OceanBase Database
- Create a project to migrate data from a TiDB database to an OceanBase database in MySQL tenant mode
- Create a project to migrate data from a PostgreSQL database to a MySQL tenant of OceanBase Database
- 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
- Features
  - DML filtering
  - Synchronize DDL operations
  - Configure matching rules for migration objects
  - Wildcard rules
  - Rename a database table
  - Use SQL conditions to filter data
  - Create and update a heartbeat table
  - Schema migration mechanisms
  - Schema migration operations
- Supported DDL operations in incremental migration and limits
  - Supported DDL operations in incremental migration from a MySQL database to a MySQL tenant of OceanBase Database and limits
  - Supported DDL operations in incremental migration from a MySQL tenant of OceanBase Database to a MySQL database and limits
  - Supported DDL operations in incremental migration from an Oracle database to an Oracle tenant of OceanBase Database
  - Supported DDL operations in incremental migration from an Oracle tenant of OceanBase Database to an Oracle database
  - Dynamic DDL operations during data migration between an Oracle tenant of OceanBase Database and a DB2 LUW database
  - Supported DDL operations in incremental migration from a DB2 LUW database to a MySQL tenant of OceanBase Database and limits
  - Supported DDL operations in incremental migration from a MySQL tenant of OceanBase Database to a DB2 LUW database and limits
  - Supported DDL operations in incremental migration between MySQL tenants of OceanBase Database
  - Supported DDL operations in incremental migration between Oracle tenants of OceanBase Database
Data synchronization
- Data synchronization overview
- Create a project to synchronize data from an OceanBase database to a Kafka instance
- Create a project to synchronize data from an OceanBase database to a RocketMQ instance
- Create a project to synchronize data from an OceanBase database to a DataHub instance
- Create a project to synchronize data from a DBP logical table to a physical table in the MySQL tenant of OceanBase Database
- Create a project to synchronize data from a DBP logical table to a DataHub instance
- Create a project to synchronize data from an IDB logical table to the MySQL tenant of OceanBase Database
- Create a project to synchronize data from an IDB logical table to a DataHub instance
- Create a project to synchronize data from a MySQL database to a DataHub instance
- Create a project to synchronize data from an Oracle database to a DataHub 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
- Features
  - DML filtering
  - Synchronize DDL operations
  - Rename databases and tables
  - Rename a topic
  - Use SQL conditions to filter data
  - Column filtering
  - Data formats
Create and manage data sources
- Create data sources
  - Create an OceanBase data source
    - Create a physical OceanBase data source
    - Create a DBP data source
    - Create an IDB 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
- 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 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
- User management
- Alert center
  - View project alerts
  - View system alerts
  - Manage alert settings
- Associate with OCP
- System parameters
  - Modify system parameters
  - Modify HA configurations
- Operation audit
O&M Guide
- Manage OMS services
- OMS logs
- O&M operations for the Store component
- Store parameters
  - Parameters of an Oracle store
  - Parameters of a DB2 store
  - 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 of a destination DataHub instance
  - Parameters of the source Sybase database
  - 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
  - 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
    - 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 upgrade Store?
Release Note
- 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