Sign In

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.

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.

PRODUCTS

OceanBase Cloud

OceanBase Database

Tools Connectors and Middleware

QUICK START

OceanBase Cloud OceanBase Database

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

OceanBase Migration Service

V4.2.4Community 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
- Check the deployment
- Scale out OMS Community Edition
- Integrate the OIDC protocol into OMS Community Edition to implement SSO
- Deploy OMS Community Edition on multiple nodes in multiple regions
- System and network requirements
- Deploy OMS Community Edition on multiple nodes in a single region
- Deploy OMS Community Edition on a single node
- Deploy a time-series database (Optional)
OMS Community Edition console
- Overview
- Log on to the console of OMS Community Edition
- User center
  - Change your logon password
  - Log off
  - Configure user information
Data migration
- Migrate incremental data from OBKV to HBase
- Migrate data from a PostgreSQL database to OceanBase Database Community Edition
- Overview
- Migrate data from HBase to OBKV
- Migrate data in active-active disaster recovery scenarios
- Migrate data from a TiDB database to OceanBase Database Community Edition
- Migrate data between instances of OceanBase Database Community Edition
- Migrate data from a MySQL database to OceanBase Database Community Edition
- Supported DDL operations in incremental migration and limits
  - Supported DDL operations in incremental migration between MySQL tenants of OceanBase Database
  - DDL synchronization from MySQL database to OceanBase Community Edition
    - Overview of DDL synchronization from a MySQL database to a MySQL 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
- 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 the 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
  - 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
  - Direct load
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 formats
Create and manage data sources
- Create data sources
  - Create a RocketMQ data source
  - Create a TiDB data source
  - Create a PostgreSQL data source
  - Create an HBase data source
  - Create a Kafka data source
  - Create an OceanBase-CE data source
  - Create a MySQL data source
- Manage data sources
  - 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
    - Start and pause a store
    - Update the configurations of a store
    - Delete a store
    - View details of a store
  - 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
- 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
- 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 parameters
  - Coordinator
  - Condition
  - Source Plugin
    - Overview
    - LogProxySource
    - HBaseSource
    - StoreSource
    - KafkaSource (TiDB)
    - DataFlowSource
  - Sink Plugin
    - Overview
    - JDBC-Sink
    - KafkaSink
    - DatahubSink
    - RocketMQSink
    - HBaseSink
  - Store parameters
    - Parameters of a MySQL store
    - Parameters of an OceanBase store
  - Parameters of the CM component
  - Parameters of the Supervisor component
  - Parameters of the Full-Verification component
- Component O&M
  - CLI-based O&M for the Connector component
  - O&M operations for the Supervisor component
  - O&M operations for the Store component
- Component tuning
  - Incr-Sync or Full-Import tuning
Reference Guide
- API Reference
  - StopProject
  - UpdateFullImport
  - Overview
  - ListFullVerifyCorrectionsResult
  - ListProjects
  - DescribeProjectStepMetric
  - ListProjectFullVerifyResult
  - UpdateFullVerification
  - DeleteProject
  - ResumeProject
  - DescribeProject
  - CreateMysqlDataSource
  - CreateOceanBaseDataSource
  - CreateLabel
  - ListAllLabels
  - UpdateIncrSync
  - DescribeProjectSteps
  - ListDataSource
  - ListFullVerifyInconsistenciesResult
  - StartProjectsByLabel
  - ReleaseProject
  - StartProject
  - DescribeProjectProgress
  - StopProjectsByLabel
  - DescribeProjectComponents
  - CreateProject
  - UpdateStore
  - CreateMySQLMasterSlaveDataSource
- 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
Upgrade Guide
- Overview
- Upgrade OMS Community Edition in single-node deployment mode
- Upgrade OMS Community Edition in multi-node deployment mode
- FAQ
FAQ
- Installation and deployment
  - What do I do when the "Failed to fetch" error is reported?
  - Change port numbers for components
  - Switch to the standby database
  - How do I upgrade CDC?
  - How do I upgrade Store?
- 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 destination table does not exist?
    - How do I query the verification result files of the Checker component of OMS?
  - Incremental synchronization
    - How do I update whitelists and blacklists?
    - What are the application scope and limits of ETL?
    - How do I skip DDL statements?
- 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?
- Logon and password
  - What do I do if my logon password is locked?
- Data synchronization
  - FAQ about synchronization to a message queue
    - What are the strategies for ensuring the message order in incremental data synchronization to Kafka

Download PDF

Document Feedback

View server information

Last Updated：2026-04-14 07:41:43 Updated

share

share

The OceanBase Migration Service (OMS) Community Edition console allows you to view the resource usage of servers by region.

Log on to the OMS Community Edition console.

In the left-side navigation pane, choose OPS & Monitoring > Server.

On the Servers page of the target region, you can perform O&M operations on a target server, such as viewing various information of the server, updating the server, and viewing its logs. You can enter an IP address in the search box in the upper-right corner to search for the target server.

Parameter	Description
Server IP Address	The private IP address of the server.
Region	For single-region deployment, the region information is displayed on the right of Server, and the region column is not displayed. For multi-region deployment, you can filter servers by region and view information of servers deployed in the target region.
Memory	The memory usage of the server. It is indicated by a percentage progress bar, helping you easily learn about the resource usage. You can sort servers in ascending or descending order of memory usage.
CPU	The CPU utilization of the server. It is indicated by a percentage progress bar, helping you easily learn about the resource usage. You can sort servers in ascending or descending order of CPU utilization.
Disk	The disk usage of the server. It is indicated by a percentage progress bar, helping you easily learn about the resource usage. You can sort servers in ascending or descending order of disk usage.
Status	The status of the target server.
Type	The types of components that can be run on the server. Valid values: Store, Full-Verification, Full-Import, and Incr-Sync.
Usage	The number of active processes of each component on the server. Full-Import and Incr-Sync share the same process.
Upper Limit	The maximum number of resources of this type that can be run on the server. A store has an exclusive quota, and other components share the same quota.

Previous topic

Go to the overview page

Next topic

Update the quota