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

OceanBase Migration Service

V4.2.13Community 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
  - Single-region multi-node deployment
  - Check the deployment
  - Deploy a time-series database (Optional)
  - Single-node deployment
  - Scale out
  - Multi-region multi-node deployment
- 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
- Migrate incremental data from OBKV to HBase
- Migrate data from a PostgreSQL database to OceanBase Database Community Edition
- Migrate data from a StarRocks database to OceanBase Database Community Edition
- Overview
- Migrate data from a Doris database to OceanBase Database Community Edition
- Migrate data from a Redis database to an OBKV-Redis database
- Migrate data from HBase to OBKV
- Migrate data from a MongoDB database to OceanBase Database Community Edition
- Migrate data from a Milvus database to OceanBase Database Community Edition
- Migrate data from Hive to OceanBase Database Community Edition
- Migrate data from a Qdrant database to 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 OceanBase Database Community Edition to an ElasticSearch database
- Migrate data between tenants of OceanBase Database Community Edition
- Migrate data from a ClickHouse database to OceanBase Database Community Edition
- Migrate data from a MySQL database to OceanBase Database Community Edition
- Migrate data from an ElasticSearch database to OceanBase Database Community Edition
- Supported DDL operations in incremental migration and limits
  - Synchronize DDL operations from a PostgreSQL database to OceanBase Database
  - Supported DDL operations in incremental migration between MySQL-compatible tenants of OceanBase Database
  - 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
- 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
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 ClickHouse 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 Doris 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
      - ElasticSearch Store
      - MongoDB Store
      - Parameters of a MySQL store
      - Parameters of an OceanBase store
- Server
  - Update the quota
  - View server logs
  - Delete a server
  - 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
- SSO management
  - Overview
  - Create an SSO integration
  - Enable or disable an SSO integration
  - Edit an SSO integration
  - Delete an SSO integration
- 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
  - GetPreCheckResult
  - StopProject
  - UpdateFullImport
  - Overview
  - CreateKafkaDataSource
  - ListFullVerifyCorrectionsResult
  - UploadFile
  - ListProjects
  - CreateMySQLMasterSlaveDataSource
  - RetryPreCheck
  - DescribeProjectStepMetric
  - ListProjectFullVerifyResult
  - UpdateFullVerification
  - DeleteProject
  - ResumeProject
  - DescribeProject
  - CreateMysqlDataSource
  - CreateOceanBaseDataSource
  - CreateLabel
  - ListAllLabels
  - UpdateIncrSync
  - SubmitPreCheck
  - DescribeProjectSteps
  - ListDataSource
  - ListFullVerifyInconsistenciesResult
  - StartProjectsByLabel
  - ReleaseProject
  - StartProject
  - DescribeProjectProgress
  - StopProjectsByLabel
  - DescribeProjectComponents
  - DeleteDataSource
  - 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
- Single-node upgrade
- Multi-node upgrade
- Hot upgrade of OMS Community Edition
- FAQ
- Upgrade the CDC library
FAQ
- 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?
- 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 allowlists and blocklists?
    - What are the application scope and limits of ETL?
- 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?

Download PDF

Document Feedback

How do I modify the resource quotas of an OMS container?

Last Updated：2026-04-16 07:09:24 Updated

Notice:

${container_name} in the following commands specifies the name of the OceanBase Migration Service (OMS) container. Replace it with the actual container name.

Modify the CPU quota

# Dynamically update the number of CPU cores that the OMS container can use to 32.
docker update ${container_name} --cpu-quota 3200000

Modify the memory quota

# Dynamically update the memory that the OMS container can use to 256 GB.
docker update ${container_name} --memory 256G

Specify the CPU cores to be used

# Dynamically update the CPU cores to be used by the OMS container to cores 0 to 31.
docker update ${container_name} --cpuset-cpus=0-31

Previous topic

FAQ

Last

Next topic

Clear files in the Store component