Environment preparations|V4.3.0|OceanBase Migration Service|OMS docs|Distributed Database

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 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.3.0Enterprise Edition

OMS Documentation
OMS Introduction
- Overview of OMS
- Terms
- OMS HA
- Principles of Store
- Principles of Full-Import and Incr-Sync
- Data verification principles
- Architecture
  - Overview
  - Hierarchical functional system
  - Basic components
- OMS Oracle full migration design and impact
- Limitations
Quick Start
- Data migration process
- Data synchronization process
Deploy OMS
- Environment preparations
- Memory and disk requirements
- Deployment types
- Check the deployment
- Scale out
- Deploy OMS on multiple nodes in multiple regions
- System and network requirements
- Deploy OMS on multiple nodes in a single region
- Deploy OMS on a single node
- Deploy a time-series database (Optional)
OMS console
- Overview
- Log in to the OMS console
- User center
  - Change your login password
  - Log out
  - Configure user information
Data migration
- Overview
- Migrate data from a MySQL database to a MySQL-compatible tenant of OceanBase Database
- Migrate data from a MySQL-compatible tenant of OceanBase Database to a MySQL database
- Migrate data from an Oracle database to the MySQL compatible mode of OceanBase Database
- Migrate data from the Oracle compatible mode of OceanBase Database to an Oracle database
- Migrate data from an Oracle database to the Oracle compatible mode of OceanBase Database
- Migrate data from a DB2 LUW database to an Oracle-compatible tenant of OceanBase Database
- Migrate data from an Oracle-compatible tenant of OceanBase Database to a DB2 LUW database
- Migrate data from a DB2 LUW database to a MySQL-compatible tenant of OceanBase Database
- Migrate data from a MySQL-compatible tenant of OceanBase Database to a DB2 LUW database
- Migrate data from one OceanBase database to another OceanBase database in the same tenant type
- Create an active-active disaster recovery task in OceanBase Database
- Migrate data from a TiDB database to a MySQL-compatible tenant of OceanBase Database
- Migrate data from a PostgreSQL database to the MySQL compatible mode of OceanBase Database
- Migrate data from a PolarDB-X 1.0 database to a MySQL-compatible tenant of OceanBase Database
- Migrate incremental data from an Oracle-compatible tenant of OceanBase Database to a MySQL database
- Manage data migration tasks
  - Start and pause a data migration task
  - Use tags to Manage data migration tasks
  - Download and import settings of migration objects
  - Download a conflict log file
  - View and modify migration objects
  - View and modify migration parameters
  - Rename a data migration task
  - End and delete a data migration task
  - View details of a data migration task
  - Perform batch operations on data migration tasks
- Supported DDL operations and limits for synchronization
  - Synchronize DDL operations from a MySQL database to a MySQL-compatible tenant of OceanBase Database
    - Overview of DDL synchronization from MySQL to OceanBase Database's MySQL compatible mode
    - CREATE TABLE
      - Create a table
      - Create a column
      - Create indexes or constraints
      - Create partitions
    - Data type conversion
    - ALTER TABLE
      - Modify tables
      - Operations on columns
      - Partition operations
      - Operations on constraints and indexes
    - TRUNCATE TABLE
    - RENAME TABLE
    - DROP TABLE
    - CREATE INDEX
    - DROP INDEX
    - DDL incompatibilities between a MySQL database and a MySQL-compatible tenant of OceanBase Database
      - 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
  - Synchronize DDL operations from the MySQL compatible mode of OceanBase Database to a MySQL database
  - DDL operations for synchronizing data from an Oracle database to an Oracle-compatible tenant of OceanBase Database
    - Overview of DDL synchronization from Oracle to OceanBase Database Oracle compatible mode
    - CREATE TABLE
      - Overview for CREATE TABLE
      - Create a relational table
        Create a relational table
        Define columns of a relational table
      - Virtual columns
      - Regular columns
      - Create partitions
        User-defined partitioning
        Composite partitioning
        Overview for creating partitions
        Subpartition templates
        Subpartitioning
        Partitioning
      - Constraints
        Overview
        Inline constraints
        Out-of-line constraints
    - CREATE INDEX
      - Overview
      - Oracle compatible mode
    - ALTER TABLE
      - Modify, drop, and add constraints
      - Modify, drop, and add table attributes
      - Overview
      - Column attribute management
        Modify, drop, and add column attributes
        Rename a column
        Add columns and column attributes
        Modify column attributes
        Drop columns
      - Partition management
        Drop a subpartition
        Modify partitions
        Drop a partition
        Drop partition data
        Modify, drop, and add partitions
        Add partitions and subpartitions
    - DROP TABLE
    - RENAME OBJECT
    - TRUNCATE TABLE
    - DROP INDEX
    - DDL incompatibilities between an Oracle database and an Oracle-compatible tenant of OceanBase Database
      - Overview
      - Incompatibilities of CREATE TABLE
      - Incompatibilities in table modification operations
        Incompatibilities of ALTER TABLE
        Change the type of a constrained column
        Change the type of an unconstrained column
        Change the length of a constrained column
        Change the length of an unconstrained column
  - Synchronize DDL operations from the Oracle compatible mode of OceanBase Database to an Oracle database
  - Synchronize DDL operations from a DB2 LUW database to an Oracle-compatible tenant of OceanBase Database
  - Synchronize DDL operations from the Oracle compatible mode of OceanBase Database to a DB2 LUW database
  - Synchronize DDL operations from a DB2 LUW database to a MySQL-compatible tenant of OceanBase Database
  - Synchronize DDL operations from the MySQL compatible mode of OceanBase Database to a DB2 LUW database
  - Synchronize DDL operations between MySQL-compatible tenants of OceanBase Database
  - DDL synchronization between Oracle-compatible tenants of OceanBase Database
Data synchronization
- Overview
- Synchronize data from OceanBase Database to a Kafka instance
- Synchronize data from OceanBase Database to a RocketMQ instance
- Synchronize data from OceanBase Database to a DataHub instance
- Synchronize data from an ODP logical table to a physical table in a MySQL-compatible tenant of OceanBase Database
- Synchronize data from an ODP logical table to a DataHub instance
- Synchronize data from an IDB logical table to a MySQL-compatible tenant of OceanBase Database
- Synchronize data from an IDB logical table to a DataHub instance
- Synchronize data from a MySQL database to a DataHub instance
- Synchronize data from an Oracle database to a DataHub instance
- Manage data synchronization tasks
  - View details of a data synchronization task
  - Download and import the settings of synchronization objects
  - View and modify the parameter configurations of a data synchronization task
  - View and modify synchronization objects
  - End 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
Create and manage data sources
- Create data sources
  - Create a RocketMQ data source
  - Create an Oracle data source
  - Create a DB2 LUW data source
  - Create a TiDB data source
  - Create a PostgreSQL data source
  - Create a Kafka data source
  - Create a PolarDB-X 1.0 data source
  - Create a DataHub data source
  - Create a MySQL data source
  - Create an OceanBase data source
    - Create a standalone OceanBase data source
    - Create an ODP data source
    - Create an IDB data source
    - Create a public cloud OceanBase data source
    - Create a physical OceanBase 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
- Minimum privileges required when an Oracle database serves as the source
OPS & Monitoring
- O&M overview
- Go to the overview page
- Server
  - Update the quota
  - View server logs
  - View server information
  - Manage resource groups
- Components
  - Store
    - Add 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
    - View details of a Full-Import component
    - Pause a Full-Import component
    - Rerun and resume a Full-Import component
    - Update the configurations of a Full-Import component
    - Delete 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
- O&M Task
  - View O&M tasks
  - Skip a task or subtask
  - Retry a task or subtask
- Parameter Template
  - Overview
  - Component parameters
    - Full-Import component parameters
    - Store component parameters
    - Full-Verification component parameters
    - Supervisor component parameters
    - Incr-Sync component parameters
    - CM component parameters
  - Component Template
    - Delete a component template
    - Copy and export a component template
    - View and edit component templates
    - Create a component template
  - Task Template
    - Create a task template
    - Copy and export a task template
    - View and edit task templates
    - Delete a task template
System management
- Permission Management
  - Overview
  - Manage users
  - Manage departments
- Alert center
  - Manage alert settings
  - View system alerts
  - View task alerts
- Associate with OCP
- System parameters
  - Modify HA configurations
  - oblogproxy parameters
  - Modify system parameters
- Manage access keys
- Operation audit
Troubleshooting Guide
- OMS logs
- Set throttling
- Store performance diagnostics
- Manage OMS services
- Component tuning
  - Oracle store tuning
  - Incr-Sync/Full-Import tuning
- 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
Reference Guide
- Features
  - Change a topic
  - Hidden column mechanisms
  - Column filtering
  - Rename databases and tables
  - Configure DDL/DML synchronization
  - Configure matching rules
  - Data formats
  - Use SQL conditions to filter data
  - DDL synchronization scope
  - Instructions on schema migration
  - Set the incremental synchronization start timestamp
  - Create and update a heartbeat table
  - Wildcard patterns supported for matching rules
- API Reference
  - StopProject
  - Overview
  - ListProjects
  - CreateOceanBaseODPDataSource
  - DownloadConflictData
  - DescribeProjectStepMetric
  - Download schema conversion information
  - UpdateProjectConfig
  - StopProjectModifyRecords
  - ListProjectFullVerifyResult
  - DeleteProject
  - ResumeProject
  - DescribeProject
  - CreateMysqlDataSource
  - DeleteDataSource
  - CreateOceanBaseDataSource
  - CreateLabel
  - ListProjectModifyRecords
  - ListAllLabels
  - SubmitPreCheck
  - CreateProjectModifyRecords
  - CancelProjectModifyRecord
  - ResetIncrStartTimestamp
  - DescribeProjectSteps
  - ListDataSource
  - StartProjectsByLabel
  - ReleaseProject
  - RetryProjectModifyRecords
  - StartProject
  - CreatePolarDBDataSource
  - DescribeProjectProgress
  - StopProjectsByLabel
  - DescribeProjectComponents
  - CreateProject
  - GetPreCheckResult
  - ListConflictData
- 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
- SSO
  - Integrate the OIDC protocol to OMS to implement SSO
  - Integrate the SAML 2.0 protocol to OMS to implement SSO
  - Access Microsoft Entra ID using OMS SAML 2.0
- OMS error codes
- SQL statements for querying table objects
- Create a trigger
- Change the log level for a PostgreSQL instance
- Online DDL tools
- Supplemental logging in Oracle databases
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?
  - Deploy InfluxDB for OMS
  - Increase the disk space of the OMS host
- Task 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
    - 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?
    - What can I do when the full migration failed due to LOB fields?
    - What do I do if garbled characters cannot be written into OceanBase Database V3.1.2?
  - Incremental synchronization
    - How do I skip DDL statements?
    - How do I migrate an Oracle database object whose name exceeds 30 bytes in length?
    - 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.3
  - OMS V3.3.1
  - OMS V3.3.0
- V4.2
  - OMS V4.2.5
  - OMS V4.2.4
  - OMS V4.2.3
  - OMS V4.2.2
  - OMS V4.2.1
  - OMS V4.2.0
- V4.0
  - OMS V4.0.2
  - OMS V4.0.1
- V3.2
  - OMS V3.2.1
  - OMS V3.2.2
- V3.1
  - OMS V3.1.0
- V3.4
  - OMS V3.4.0
- V2.1
  - OMS V2.1.2
  - OMS V2.1.0
- V4.3
  - OMS V4.3.0
- V4.1
  - OMS V4.1.0

Download PDF