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

OMS Documentation
OMS Introduction
- What is OMS?
- Terms
- OMS HA
- OMS Oracle full data migration design and impact
- Limitations
- Architecture
  - Hierarchical functional system
  - Overview
  - Basic components
Quick Start
- Data migration process
- Data synchronization process
Deploy OMS
- Environment preparations
- Memory and disk requirements
- Deployment types
- Check the deployment
- Scale out OMS
- Integrate the OIDC protocol to OMS to implement SSO
- Deploy OMS on multiple nodes in multiple regions
- System and network requirements
- Deploy OMS on multiple nodes in a single region
- Single-node deployment
- Deploy a time-series database (Optional)
OMS console
- Overview
- Log on to the OMS console
- User center
  - Change your logon password
  - Log off
  - Configure user information
Data migration
- Migrate data from an Oracle database to an Oracle tenant of OceanBase Database
- Migrate data from a MySQL tenant of OceanBase Database to a DB2 LUW 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
- Overview
- Migrate data from an Oracle database to a MySQL tenant of 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 MySQL tenant of OceanBase Database to a MySQL database
- Migrate data within OceanBase Database
- Migrate data from a DB2 LUW database to a MySQL tenant of OceanBase Database
- Migrate data from an Oracle tenant of OceanBase Database to an Oracle database
- Migrate data from a DB2 LUW database to an Oracle tenant of OceanBase Database
- Migrate data from a MySQL database to a MySQL tenant of OceanBase Database
- Migrate data from an Oracle tenant of OceanBase Database to a DB2 LUW database
- Supported DDL operations and limits for synchronization
  - Synchronize DDL operations from a MySQL tenant of OceanBase Database to a MySQL database
  - Synchronize DDL operations from a DB2 LUW database to an Oracle tenant of OceanBase Database
  - DDL synchronization between MySQL tenants of OceanBase Database
  - Synchronize DDL operations from a DB2 LUW database to a MySQL tenant of OceanBase Database
  - DDL synchronization between Oracle tenants of OceanBase Database
  - Synchronize DDL operations from an Oracle tenant of OceanBase Database to an Oracle database
  - Synchronize DDL operations from a MySQL tenant of OceanBase Database to a DB2 LUW database
  - Synchronize DDL operations from an Oracle tenant of OceanBase Database to a DB2 LUW database
  - DDL operations for synchronizing data from an Oracle database to an Oracle tenant of OceanBase Database
    - COMMENT
    - Overview
    - DROP TABLE
    - DROP INDEX
    - TRUNCATE TABLE
    - RENAME OBJECT
    - ALTER TABLE
      - Modify, drop, and add constraints
      - Modify, drop, and add table attributes
      - Modify tables
      - Column attribute management
        Add columns and column attributes
        Drop columns
        Modify, drop, and add column attributes
        Modify column attributes
        Rename a column
      - Partition management
        Drop subpartitions
        Modify partitions
        Drop partitions
        Truncate partitions
        Modify, drop, and add partitions
        Add partitions and subpartitions
    - CREATE TABLE
      - Virtual columns
      - Regular columns
      - Overview
      - Constraints
        Overview
        Inline constraints
        Out-of-line constraints
      - Create partitions
        User-defined partitioning
        Composite partitioning
        Overview
        Subpartition templates
        Subpartitioning
        Partitioning
      - Create a relational table
        Create a relational table
        Define columns of a relational table
    - 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 an unconstrained column
        Change the length of an unconstrained column
        Change the type of a constrained column
        Change the length of a constrained column
    - CREATE INDEX
      - Overview
      - Normal indexes
  - DDL synchronization from a MySQL database to a MySQL tenant of OceanBase Database
    - TRUNCATE TABLE
    - RENAME TABLE
    - Data type conversion
    - DROP TABLE
    - Overview of DDL synchronization from a MySQL database to a MySQL tenant of OceanBase Database
    - DROP INDEX
    - CREATE INDEX
    - DDL incompatibilities between a MySQL database and a MySQL 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
    - ALTER TABLE
      - Modify a table
      - Operations on columns
      - Operations on partitions
      - Operations on constraints and indexes
    - CREATE TABLE
      - Create partitions
      - Create an index or a constraint
      - Create a column
      - Create a table
- Manage data migration projects
  - Start and pause a data migration project
  - Use tags to manage data migration projects
  - Download and import settings of migration objects
  - View and modify migration objects
  - Rename a data migration project
  - Release and delete a data migration project
  - View details of a data migration project
  - Perform batch operations on data migration projects
Data synchronization
- Overview
- 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 DataHub instance
- Synchronize data from an IDB logical table to a physical table in a MySQL tenant of OceanBase Database
- Synchronize data from OceanBase Database to a Kafka instance
- Synchronize data from an Oracle database to a DataHub instance
- 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 ODP logical table to a physical table in a MySQL tenant of OceanBase Database
- Manage data synchronization projects
  - View details of a data synchronization project
  - Download and import the settings of synchronization objects
  - View and modify synchronization objects
  - Release and delete a data synchronization project
  - Start and pause a data synchronization project
  - Perform batch operations on data synchronization projects
  - Change the name of a data synchronization project
  - Use tags to manage data synchronization projects
Create and manage data sources
- Create a database user
- Enable binlogs for the MySQL database
- Minimum privileges required when an Oracle database serves as the source
- User privileges
- 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 DataHub data source
  - Create a MySQL data source
  - Create an 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
OPS & Monitoring
- Go to the overview page
- O&M overview
- Components
  - 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
    - Delete a Full-Verification component
    - Rerun and resume a Full-Verification component
    - Update the configurations of a Full-Verification component
    - Pause a Full-Verification 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
  - Store
    - Create a store
    - Start and pause a store
    - Update the configurations of a store
    - Delete a store
    - View details of a store
- Server
  - Update the quota
  - View server logs
  - View server information
- Parameter Template
  - Overview
  - Component parameters
    - Full-Import parameters
    - Store parameters
    - Full-Verification parameters
    - Supervisor parameters
    - Incr-Sync parameters
    - CM parameters
  - Component Template
    - Delete a component template
    - Copy and export a component template
    - View and edit component templates
    - Create a component template
  - Project Template
    - Create a project template
    - Copy and export a project template
    - View and edit project templates
    - Delete a project template
- O&M Task
  - Retry a task or subtask
  - Skip a task or subtask
  - View O&M tasks
System management
- Operation audit
- Associate with OCP
- System parameters
  - Modify HA configurations
  - oblogproxy parameters
  - Modify system parameters
- Permission Management
  - Manage departments
  - Manage users
  - Overview
- Alert center
  - Manage alert settings
  - View system alerts
  - View project alerts
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
  - CLI-based O&M for the Connector component
  - O&M operations for the Supervisor component
  - O&M operations for the Store component
Reference Guide
- OMS error codes
- SQL statements for querying table objects
- Create a trigger
- Change the log level for a PostgreSQL instance
- Features
  - Change the topic
  - Hidden column mechanisms
  - Column filtering
  - Rename a migration or synchronization object
  - DML filtering
  - Configure matching rules for migration objects
  - Data formats
  - Use SQL conditions to filter data
  - DDL synchronization
  - Instructions on schema migration
  - Set an incremental synchronization timestamp
  - Create and update a heartbeat table
  - Wildcard patterns supported for matching rules
- API Reference
  - StopProject
  - Overview
  - ListProjects
  - CreateOceanBaseODPDataSource
  - DescribeProjectStepMetric
  - ListProjectFullVerifyResult
  - DeleteProject
  - ResumeProject
  - DescribeProject
  - CreateMysqlDataSource
  - DeleteDataSource
  - CreateOceanBaseDataSource
  - CreateLabel
  - ListProjectModifyRecords
  - ListAllLabels
  - CreateProjectModifyRecords
  - CancelProjectModifyRecord
  - DescribeProjectSteps
  - ListDataSource
  - StartProjectsByLabel
  - ReleaseProject
  - RetryProjectModifyRecords
  - StartProject
  - DescribeProjectProgress
  - StopProjectsByLabel
  - DescribeProjectComponents
  - CreateProject
  - StopProjectModifyRecords
  - SubmitPreCheck
  - GetPreCheckResult
- 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
Upgrade Guide
- Overview
- Upgrade OMS in single-node deployment mode
- Upgrade OMS in multi-node deployment mode
- FAQ
FAQ
- Data migration
  - Incremental synchronization
    - 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?
    - How do I skip DDL statements?
  - 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?
  - User privileges
    - What privileges do I need to grant to a user during data migration to or from an Oracle database?
- Project 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?
  - How do I troubleshoot common problems with Oracle Store?
  - How do I use LogMiner to pull data from an Oracle database?
  - How do I perform performance tuning for Oracle Store?
  - What do I do when Oracle Store reports an error at the isUpdatePK stack?
- OPS & monitoring
  - What are the alert rules?
- General O&M
  - 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?
- Data synchronization
  - FAQ about synchronization to a message queue
    - What are the strategies for ensuring the message order in incremental data synchronization to Kafka
- 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.0
  - OMS V4.2.1
  - OMS V4.2.2
- 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.0
  - OMS V2.1.2
- V4.1
  - OMS V4.1.0

Download PDF

Document Feedback

Edit a data source

Last Updated：2025-06-04 08:36:33 Updated

OceanBase Migration Service (OMS) allows you to modify parameters of a data source. This topic describes how to edit a data source.

Procedure

Log on to the OMS console.
In the left-side navigation pane, click Data Source Management.
On the Data Source Management page, click Edit next to the target data source.

If your business system is deployed in multiple regions, you can use the Region column to filter and edit data sources in a specific region.

In the Edit Data Source dialog box, change the values of parameters as needed.

Note

The data source edit operation takes effect only for newly created data migration and synchronization projects, and does not affect existing projects.

For more information about the parameters, see the topic that describes how to create the corresponding type of data source. The following table lists the parameters that can be modified for different types of data sources.

Data source type	Modifiable parameter
Physical OceanBase data source	Database Username, Database Password, DRC User Name, Password, and __OCEANBASE_INNER_DRC_USER Password
ODP data source (logical OceanBase data source)	Access Key, Security Key, Database Username, Database Password, DRC User Name, and Password
IDB data source (logical OceanBase data source)	IDB Username, IDB Password, Bagualu Username, Bagualu Password, Full Synchronization User, Full Synchronization Password, DRC User Name, and Password
Oracle/MySQL/PostgreSQL/DB2 LUW/TiDB data source	Database Username and Database Password
DataHub/RocketMQ data source	AccessKey and SecretKey
Kafka data source	Username and Password, provided that authentication is enabled and the authentication method is not GSSAPI

Click Test Connection to test the network connection between OMS and the source database.
After the connection test is passed, click Save.

Previous topic

Copy a data source

Last

Next topic

Delete a data source