Sign In

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.

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.8Community Edition

OMS Documentation
What's New
OMS Community Edition Introduction
- What is OMS Community Edition?
- Terms
- OMS Community Edition HA
- Architecture
  - Overview
  - Hierarchical functional system
  - 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
- Overview
- Migrate data from a MySQL database to OceanBase Database Community Edition
- Migrate data from HBase to OBKV
- Migrate incremental data from OBKV to HBase
- Migrate data from a Milvus database to OceanBase Database Community Edition
- Migrate data from a Redis database to an OBKV-Redis database
- Migrate data between tenants of 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 a PostgreSQL database to OceanBase Database Community Edition
- Migrate data from a Hive database to OceanBase Database Community Edition
- Migrate data from a Qdrant database to OceanBase Database Community Edition
- 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
  - DML filtering
  - DDL synchronization
  - Configure matching rules for migration objects
  - Wildcard rules
  - Rename a database table
  - Use SQL conditions to filter data
  - Create and update a heartbeat table
  - Schema migration mechanisms
  - Schema migration operations
  - Direct load
  - Set an incremental synchronization timestamp
- Supported DDL operations in incremental migration and limits
  - 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
  - Supported DDL operations in incremental migration between MySQL-compatible tenants of OceanBase Database
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 Milvus data source
  - 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 a Qdrant data source
  - Create an OceanBase-CE data source
  - Create a Hive data source
  - Create a Redis 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
- O&M overview
- Go to the overview page
- Server
  - Update the quota
  - View server logs
  - View server information
- 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
    - 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
  - Component parameters
    - Parameters of the CM component
    - Parameters of the Full-Verification component
    - Condition
    - Coordinator
    - Parameters of the Supervisor component
    - Sink Plugin
      - JDBC-Sink
      - HBaseSink
      - DatahubSink
      - RocketMQSink
      - KafkaSink
      - HiveSink
      - Overview
    - Source Plugin
      - Overview
      - StoreSource
      - DataFlowSource
      - LogProxySource
      - KafkaSource (TiDB)
      - HBaseSource
      - HiveSource
    - Store parameters
      - Parameters of a MySQL store
      - Parameters of an OceanBase store
- O&M Task
  - View O&M tasks
  - Skip a task or subtask
  - Retry a task or subtask
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
  - Modify system parameters
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
  - Incr-Sync or Full-Import tuning
Reference Guide
- API Reference
  - StopProject
  - UpdateFullImport
  - Overview
  - ListFullVerifyCorrectionsResult
  - ListProjects
  - CreateMySQLMasterSlaveDataSource
  - DescribeProjectStepMetric
  - ListProjectFullVerifyResult
  - UpdateFullVerification
  - DeleteProject
  - ResumeProject
  - DescribeProject
  - CreateMysqlDataSource
  - CreateOceanBaseDataSource
  - CreateLabel
  - ListAllLabels
  - UpdateIncrSync
  - DescribeProjectSteps
  - ListDataSource
  - ListFullVerifyInconsistenciesResult
  - StartProjectsByLabel
  - ReleaseProject
  - StartProject
  - DescribeProjectProgress
  - StopProjectsByLabel
  - DescribeProjectComponents
  - 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
Upgrade Guide
- Overview
- Upgrade OMS Community Edition in single-node deployment mode
- Upgrade OMS Community Edition in multi-node deployment mode
- Upgrade the CDC library
- FAQ
FAQ
- General O&M
  - How do I modify the resource quotas of an OMS container?
  - Clear files in the Store component
  - How do I troubleshoot the OMS server down issue?
  - Deploy InfluxDB for OMS
  - Increase the disk space of the OMS host
- 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?
- 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?
    - 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 update whitelists and blacklists?
    - What are the application scope and limits of ETL?
- Logon and password
  - What do I do if my logon password is locked?
- 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 CDC?
  - How do I upgrade Store?

Download PDF

Document Feedback

View data source information

Last Updated：2025-05-12 01:55:52 Updated

share

share

After creating a data source, you can view the basic information, details, and network connection information of the data source on the data source list page. You can also filter data sources by type, sort data sources by creation time, and search for a data source through fuzzy matching.

Procedure

Log on to the OceanBase Migration Service (OMS) Community Edition console.
In the left-side navigation pane, click Data Source Management .

The Data Sources page displays all existing data sources and their basic information in columns such as Data Source ID , Data Source Type , Host IP Address , Port Number , Username , and Added At .

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

The Actions column allows you to perform the following operations:
1. Test connectivity: Click Test Connection to check the network connection of the database.
2. Copy a data source: Click Copy . In the Copy Data Source dialog box, specify the parameters. For more information, see Copy a data source.
3. Edit a data source: Click Edit . In the Edit Data Source dialog box, modify the parameters as needed.
4. Delete a data source: Click Delete . In the dialog box that appears, click Delete . For more information, see Delete a data source.
View data sources as needed on the Data Sources page.

You can filter data sources by type to quickly find data sources of a specific type. You can also enter a keyword in the search box in the upper-right corner to search for a data source through fuzzy matching.
Click Data Source Identifier of a specific data source to view its details.

Previous topic

Create a Hive data source

Next topic

Copy a data source