OceanBase Migration Service

V4.2.3Enterprise Edition

OMS Documentation
OMS Introduction
- What is OMS?
- Terms
- OMS HA
- Architecture
  - Overview
  - Hierarchical functional system
  - Basic components
- OMS Oracle full data migration design and impact
- Limitations
Quick Start
- Data migration process
- Data synchronization process
Deploy OMS
- Deployment types
- System and network requirements
- Memory and disk requirements
- Environment preparations
- Single-node deployment
- Deploy OMS on multiple nodes in a single region
- Deploy OMS on multiple nodes in multiple regions
- Integrate the OIDC protocol to OMS to implement SSO
- Scale out OMS
- 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
- Overview
- Migrate data from a MySQL database to a MySQL tenant of OceanBase Database
- Migrate data from a MySQL tenant of OceanBase Database to a MySQL database
- Migrate data from an Oracle database to a MySQL tenant of OceanBase Database
- Migrate data from an Oracle tenant of OceanBase Database to an Oracle database
- Migrate data from an Oracle database to an Oracle tenant of OceanBase Database
- Migrate data from a DB2 LUW database to an Oracle tenant of OceanBase Database
- Migrate data from an Oracle tenant of OceanBase Database to a DB2 LUW database
- Migrate data from a DB2 LUW database to a MySQL tenant of OceanBase Database
- Migrate data from a MySQL tenant of OceanBase Database to a DB2 LUW database
- Migrate data within OceanBase Database
- Active-active disaster recovery between OceanBase databases
- Migrate data from a TiDB database to a MySQL tenant of OceanBase Database
- Migrate data from a PostgreSQL database to a MySQL tenant of OceanBase Database
- Migrate incremental data from an Oracle tenant of OceanBase Database to a MySQL database
- Manage data migration projects
  - View details of a data migration project
  - Rename a data migration project
  - View and modify migration objects
  - Use tags to manage data migration projects
  - Perform batch operations on data migration projects
  - Download and import settings of migration objects
  - Start and pause a data migration project
  - Release and delete a data migration project
- Supported DDL operations and limits for synchronization
  - DDL synchronization from a MySQL database to a MySQL tenant of OceanBase Database
    - 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 constraints and indexes
      - Operations on partitions
    - TRUNCATE TABLE
    - RENAME TABLE
    - DROP TABLE
    - CREATE INDEX
    - DROP INDEX
    - DDL incompatibilities between a MySQL database and a MySQL tenant of OceanBase Database
      - Overview
      - Incompatibilities of the CREATE TABLE statement
        Incompatibilities of CREATE TABLE
        Column types that are supported to create indexes or constraints
      - Incompatibilities of the ALTER TABLE statement
        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
        Delete a constrained column
      - Incompatibilities of DROP INDEX operations
  - Synchronize DDL operations from a MySQL tenant of OceanBase Database to a MySQL database
  - DDL operations for synchronizing data from an Oracle database to an Oracle tenant of OceanBase Database
    - Overview
    - CREATE TABLE
      - Overview
      - Create a relational table
        Create a relational table
        Define columns of a relational table
      - Virtual columns
      - Regular columns
      - Create partitions
        Overview
        Partitioning
        Subpartitioning
        Composite partitioning
        User-defined partitioning
        Subpartition templates
      - Constraints
        Overview
        Inline constraints
        Out-of-line constraints
    - CREATE INDEX
      - Overview
      - Normal indexes
    - ALTER TABLE
      - Modify tables
      - Modify, drop, and add table attributes
      - Column attribute management
        Modify, drop, and add column attributes
        Rename a column
        Add columns and column attributes
        Modify column attributes
        Drop columns
      - Modify, drop, and add constraints
      - Partition management
        Modify, drop, and add partitions
        Drop partitions
        Drop subpartitions
        Add partitions and subpartitions
        Modify partitions
        Truncate partitions
    - DROP TABLE
    - COMMENT
    - RENAME OBJECT
    - TRUNCATE TABLE
    - DROP INDEX
    - DDL incompatibilities between an Oracle database and an Oracle 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 an Oracle tenant of OceanBase Database to an Oracle database
  - Synchronize DDL operations from a DB2 LUW database to an Oracle tenant of OceanBase Database
  - Synchronize DDL operations from an Oracle tenant of OceanBase Database to a DB2 LUW database
  - Synchronize DDL operations from a DB2 LUW database to a MySQL tenant of OceanBase Database
  - Synchronize DDL operations from a MySQL tenant of OceanBase Database to a DB2 LUW database
  - DDL synchronization between MySQL tenants of OceanBase Database
  - DDL synchronization between Oracle 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 tenant of OceanBase Database
- Synchronize data from an ODP logical table to a DataHub instance
- Synchronize data from an IDB logical table to a physical table in a MySQL 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 projects
  - View details of a data synchronization project
  - Change the name of a data synchronization project
  - View and modify synchronization objects
  - Use tags to manage data synchronization projects
  - Perform batch operations on data synchronization projects
  - Download and import the settings of synchronization objects
  - Start and pause a data synchronization project
  - Release and delete a data synchronization project
Create and manage data sources
- Create data sources
  - Create an OceanBase data source
    - Create a physical OceanBase data source
    - Create an ODP data source
    - Create an IDB data source
    - Create a public cloud OceanBase 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 the quota
  - View server logs
- Components
  - Store
    - Create a store
    - View details of a store
    - Update the configurations of a store
    - Start and pause a store
    - Delete a store
  - Incr-Sync
    - View details of an Incr-Sync component
    - Start and pause an Incr-Sync component
    - Migrate an Incr-Sync component
    - Update the configurations of an Incr-Sync component
    - Batch O&M
    - Delete an Incr-Sync component
  - 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
  - Project Template
    - Create a project template
    - View and edit project templates
    - Copy and export a project template
    - Delete a project template
  - Component Template
    - Create a component template
    - View and edit component templates
    - Copy and export a component template
    - Delete a component template
  - Component parameters
    - Store parameters
    - Incr-Sync parameters
    - Full-Import parameters
    - Full-Verification parameters
    - CM parameters
    - Supervisor parameters
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
  - oblogproxy parameters
- Operation audit
Troubleshooting Guide
- Manage OMS services
- OMS logs
- 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
  - Incr-Sync/Full-Import tuning
  - Oracle store tuning
- Set throttling
- Store performance diagnostics
Reference Guide
- Features
  - DML filtering
  - DDL synchronization
  - Rename a migration or synchronization object
  - Use SQL conditions to filter data
  - Set an incremental synchronization timestamp
  - Configure matching rules for migration objects
  - Wildcard patterns supported for matching rules
  - Hidden column mechanisms
  - Instructions on schema migration
  - Create and update a heartbeat table
  - Change the topic
  - Column filtering
  - Data formats
- API Reference
  - Overview
  - CreateProject
  - StartProject
  - StopProject
  - ResumeProject
  - ReleaseProject
  - DeleteProject
  - ListProjects
  - DescribeProject
  - DescribeProjectSteps
  - DescribeProjectStepMetric
  - DescribeProjectProgress
  - DescribeProjectComponents
  - ListProjectFullVerifyResult
  - StartProjectsByLabel
  - StopProjectsByLabel
  - CreateMysqlDataSource
  - CreateOceanBaseDataSource
  - CreateOceanBaseODPDataSource
  - ListDataSource
  - CreateLabel
  - ListAllLabels
  - DeleteDataSource
  - CreateProjectModifyRecords
  - ListProjectModifyRecords
  - StopProjectModifyRecords
  - RetryProjectModifyRecords
  - CancelProjectModifyRecord
  - SubmitPreCheck
  - GetPreCheckResult
- 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
- OMS error codes
- SQL statements for querying table objects
- Create a trigger
- Change the log level for a PostgreSQL instance
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
- 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
    - 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
- V4.2
  - OMS V4.2.2
  - OMS V4.2.1
  - OMS V4.2.0
- V4.1
  - OMS V4.1.0
- V4.0
  - OMS V4.0.2
  - OMS V4.0.1
- 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

OceanBase, A Highly Scalable Database for Transactional, Analytical, and AI Workloads.

Company

About OceanBase Contact Us Partner

Product

OceanBase Cloud OceanBase Enterprise Quick Start Download Pricing

Resources

Docs Blog White Paper Trust Center

Document Feedback

OMS V4.0.2

Last Updated：2024-08-16 06:00:53 Updated

Version: V4.0.2
Previous version: V4.0.1
Release date: April 24, 2023
Upgrade path:
- OceanBase Migration Service (OMS) of a version earlier than V3.2.1 must be upgraded to V3.2.1 first.
- OMS V3.2.1 and later can be directly upgraded to OMS V4.0.2.

Compatible database versions

Notice

A MySQL tenant of OceanBase Database V4.0.0 can only be the destination of data migration from MySQL Database.

Feature	OceanBase Database version	Other database versions	OCP version
Data migration	V1.4.79, V2.1.1, V2.2.20, V2.2.30, V2.2.50, V2.2.52, V2.2.70,V 2.2.72, V2.2.74, V2.2.75, V2.2.76, V2.2.76BP1, V2.2.77, V3.1.0, V3.1.1, V3.1.2, V3.2.1, V3.2.2, V3.2.3, V3.2.4, and V4.0.0	MySQL: 5.5, 5.6, 5.7, and 8.0 MariaDB: V10.2 DB2 LUW: V10.1, V10.5, V11.1, and V11.5 Oracle: 10gR2, 11gR2, and 12c, 18c, and 19c CDB/PDB PostgreSQL: 10.x	For OMS V2.x: V2.3.9, V2.4.5, and V2.5.0 V3.x V4.x
Data synchronization	V2.2.20, V2.2.30, V2.2.50, V2.2.52, V2.2.70, V2.2.72, V2.2.74, V2.2.75, V2.2.76, V2.2.76BP1, V2.2.77, V3.1.0, V3.1.1, V3.1.2, V3.2.1, V3.2.2, V3.2.3, and V3.2.4	Kafka: 0.9, 1.0, and 2.x RocketMQ: V4.x and V5.x MySQL: 5.5, 5.6, 5.7, and 8.0 Oracle: 10gR2, 11gR2, and 12c, 18c, and 19c CDB/PDB	For OMS V2.x: V2.3.9, V2.4.5, and V2.5.0 V3.x V4.x

New features

Data migration and synchronization

OMS allows you to specify the IP address and port number of oblogproxy to synchronize incremental data across isolated networks.

Feature changes and guidance

New system parameter: The oceanbase.logproxy.pool parameter is provided for specifying the IP address and port number of oblogproxy to synchronize incremental data in the following two typical cross-network scenarios:

Typical three-layer network architecture: OMS is deployed at Layer 2 as an application server. OceanBase Database and oblogproxy are deployed at Layer 3. oblogproxy serves as a proxy for forwarding incremental data.

Previous topic

OMS V4.1.0

Last

Next topic

OMS V4.0.1

Enterprise Edition

Community Edition