OceanBase logo

OceanBase

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

Resources

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

Company

Learn more about OceanBase – our company, partnerships, and trust and security initiatives.

About OceanBase

Partner

Trust Center

Contact Us

International - English
中国站 - 简体中文
日本 - 日本語
Sign In
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 CloudOceanBase Database
ToolsConnectors and Middleware
QUICK START
OceanBase CloudOceanBase 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

Contact Us

Start on Cloud
编组
All Products
    • Databases
    • iconOceanBase Database
    • iconOceanBase Cloud
    • iconOceanBase Tugraph
    • iconInteractive Tutorials
    • iconOceanBase Best Practices
    • Tools
    • iconOceanBase Cloud Platform
    • iconOceanBase Migration Service
    • iconOceanBase Developer Center
    • iconOceanBase Migration Assessment
    • iconOceanBase Admin Tool
    • iconOceanBase Loader and Dumper
    • iconOceanBase Deployer
    • iconKubernetes operator for OceanBase
    • iconOceanBase Diagnostic Tool
    • iconOceanBase Binlog Service
    • Connectors and Middleware
    • iconOceanBase Database Proxy
    • iconEmbedded SQL in C for OceanBase
    • iconOceanBase Call Interface
    • iconOceanBase Connector/C
    • iconOceanBase Connector/J
    • iconOceanBase Connector/ODBC
    • iconOceanBase Connector/NET
icon

OceanBase Migration Service

V4.0.0Community Edition

  • OMS Documentation
  • What's new
  • OMS Community Edition Introduction
    • What is OMS Community Edition?
    • Limits
    • Architecture
      • Overview
      • Hierarchical functional system
      • Basic components
    • Terms
  • Quick Start
    • Data migration process
    • Data synchronization process
  • Deploy OMS Community Edition
    • Deployment type
    • System and network requirements
    • Memory and disk requirements
    • Prepare the environment
    • Deploy OMS Community Edition on a single node
    • Deploy OMS Community Edition on multiple nodes in a single region
    • Deploy OMS Community Edition on multiple nodes in multiple regions
    • Scale-out and deployment
    • Check the deployment
    • Deploy a time-series database (Optional)
  • OMS Community Edition console
    • Log on to the OMS console
    • Overview
    • User center
      • Configure user information
      • Change your logon password
      • Log off
  • Data migration
    • Data migration overview
    • Migrate data from a MySQL database to OceanBase Community Edition
    • Migrate data from OceanBase Community Edition to a MySQL database
    • Migrate data within OceanBase Community Edition
    • Migrate data within OceanBase Community Edition in active-active disaster recovery scenarios
    • Migrate data from a TiDB database to OceanBase Community Edition
    • Migrate data from a PostgreSQL database to OceanBase Community Edition
    • Manage data migration projects
      • View details of a data migration project
      • View and modify migration objects
      • Use tags to manage data migration projects
      • Download and import the settings of migration objects
      • Start, pause, and resume a data migration project
      • Release and delete a data migration project
    • Schema migration mechanisms
    • Supported DDL operations in incremental migration and limits
      • Supported DDL operations in incremental migration from a MySQL database to OceanBase Community Edition and limits
      • Supported DDL operations in incremental migration from OceanBase Community Edition to a MySQL database and limits
      • Supported DDL operations in incremental migration between MySQL tenants of OceanBase Database
    • Configure matching rules for migration objects
  • Data synchronization
    • Data synchronization overview
    • Create a project to synchronize data from OceanBase Database Community Edition to a Kafka instance
    • Create a project to synchronize data from OceanBase Database Community Edition to a RocketMQ instance
    • Manage data synchronization projects
      • View details of a data synchronization project
      • View and modify synchronization objects
      • Use tags to manage data synchronization projects
      • Download and import the settings of synchronization objects
      • Start, pause, and resume a data synchronization project
      • Release and delete a data synchronization project
    • Data formats
  • Create and manage data sources
    • Create data sources
      • Create an OceanBase-CE data source
      • Create a MySQL data source
      • Create a TiDB data source
      • Create a Kafka data source
      • Create a RocketMQ 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
  • OPS & Monitoring
    • O&M overview
    • Go to the overview page
    • Server
      • View server information
      • Update quotas
      • View server logs
    • Components
      • Store
        • Create a store
        • View details of a store
        • Update the configurations of a store
        • Start and pause a store
        • Destroy a store
      • Connector
        • View details of a connector
        • Start and pause a connector
        • Migrate a connector
        • Update the configurations of a connector
        • Batch O\&M
        • Delete a connector
      • JDBCWriter
        • View details of a JDBCWriter
        • Start and pause a JDBCWriter
        • Migrate a JDBCWriter
        • Update the configurations of a JDBCWriter
        • Batch O\&M
        • Delete a JDBCWriter
      • Checker
        • View the information about a checker
        • Start and pause a checker
        • Rerun and reverify a checker
        • Update the configurations of a checker
        • Delete a checker
    • O&M tickets
      • View details of an O\&M ticket
      • Skip a ticket or sub-ticket
      • Retry a ticket or sub-ticket
  • 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
  • OMS Community Edition O&M
    • Manage OMS services
    • OMS logs
    • O&M operations for the Store component
    • Store parameters
      • Parameters of a MySQL store
      • Parameters of an OceanBase store
    • O&M operations for the Supervisor component
    • Parameters of the Supervisor component
    • O&M operations for the Connector component
    • Connector parameters
      • Parameters of a destination RocketMQ instance
      • Parameters of a DataflowSink instance
      • Parameters in the destination Kafka instance
      • Parameters of the source database in full migration
      • Parameters of the source database in incremental data synchronization
      • Parameters for intermediate-layer synchronization
    • Checker parameters
    • JDBCWriter parameters
    • Parameters of the CM component
  • Reference Guide
    • API Reference
      • Obtain the status of a migration project
      • Obtain the status of a synchronization project
    • OMS error codes
    • 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
  • 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?
    • 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?
    • 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
      • Full migration
        • FAQ about 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?
      • Incremental synchronization
        • How do I skip DDL statements?
        • How do I update the configurations of a JDBCWriter?
        • How do I start or stop a JDBCWriter?
        • How do I update whitelists and blacklists?
        • What are the application scope and limits of ETL?
    • Installation and deployment
      • How do I download an image?
      • How do I upgrade Store?

Download PDF

OMS Documentation What's new What is OMS Community Edition? Limits Overview Hierarchical functional system Basic components Terms Data migration process Data synchronization process Deployment type System and network requirements Memory and disk requirements Prepare the environment Deploy OMS Community Edition on a single node Deploy OMS Community Edition on multiple nodes in a single region Deploy OMS Community Edition on multiple nodes in multiple regions Scale-out and deployment Check the deployment Deploy a time-series database (Optional) Log on to the OMS console Overview Configure user information Change your logon password Log off Data migration overview Migrate data from a MySQL database to OceanBase Community Edition Migrate data from OceanBase Community Edition to a MySQL database Migrate data within OceanBase Community Edition Migrate data within OceanBase Community Edition in active-active disaster recovery scenarios Migrate data from a TiDB database to OceanBase Community Edition Migrate data from a PostgreSQL database to OceanBase Community Edition View details of a data migration project View and modify migration objects Use tags to manage data migration projects Download and import the settings of migration objects Start, pause, and resume a data migration project Release and delete a data migration project Schema migration mechanisms Supported DDL operations in incremental migration from a MySQL database to OceanBase Community Edition and limits Supported DDL operations in incremental migration from OceanBase Community Edition to a MySQL database and limits Supported DDL operations in incremental migration between MySQL tenants of OceanBase Database Configure matching rules for migration objects Data synchronization overview Create a project to synchronize data from OceanBase Database Community Edition to a Kafka instance Create a project to synchronize data from OceanBase Database Community Edition to a RocketMQ instance View details of a data synchronization project View and modify synchronization objects Use tags to manage data synchronization projects Download and import the settings of synchronization objects Start, pause, and resume a data synchronization project Release and delete a data synchronization project Data formats Create an OceanBase-CE data source Create a MySQL data source Create a TiDB data source Create a Kafka data source Create a RocketMQ data source Create a PostgreSQL data source 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 O&M overview Go to the overview page View server information Update quotas View server logs View details of an O\&M ticket Skip a ticket or sub-ticket Retry a ticket or sub-ticket Overview Manage users Manage departments View project alerts View system alerts Manage alert settings Associate with OCP Modify system parameters Modify HA configurations Manage OMS services OMS logs O&M operations for the Store component Parameters of a MySQL store Parameters of an OceanBase store O&M operations for the Supervisor component Parameters of the Supervisor component O&M operations for the Connector component Parameters of a destination RocketMQ instance Parameters of a DataflowSink instance Parameters in the destination Kafka instance Parameters of the source database in full migration Parameters of the source database in incremental data synchronization Parameters for intermediate-layer synchronization Checker parameters JDBCWriter parameters Parameters of the CM component
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & Certification
Company
About OceanBaseTrust CenterLegalPartnerContact Us
Follow Us

© OceanBase 2026. All rights reserved

Cloud Service AgreementPrivacy PolicySecurity
Contact Us
Document Feedback
  1. Documentation Center
  2. OceanBase Migration Service
  3. V4.0.0
iconOceanBase Migration Service
V 4.0.0Community Edition
Enterprise Edition
  • V 4.3.2
  • V 4.3.1
  • V 4.3.0
  • V 4.2.5
  • V 4.2.4
  • V 4.2.3
  • V 4.0.2
  • V 3.4.0
Community Edition
  • V 4.2.12
  • V 4.2.11
  • V 4.2.10
  • V 4.2.9
  • V 4.2.8
  • V 4.2.7
  • V 4.2.6
  • V 4.2.5
  • V 4.2.4
  • V 4.2.3
  • V 4.2.1
  • V 4.2.0
  • V 4.0.0
  • V 3.3.1

Configure matching rules for migration objects

Last Updated:2023-06-28 11:59:36  Updated
share
What is on this page
Background
Limits
Configure a matching rule
Wildcard rules
Asterisk (*)
Question mark (?)
Square brackets ([])
An exclamation point in square brackets ([!])

folded

share

This topic describes the background, limits, and configuration method of matching rules for migration objects, as well as the wildcard rules supported by OceanBase Migration Service (OMS) Community Edition.

Background

OMS Community Edition supports DDL statements for incremental migration. However, if a new table is created in the source database during migration, the data in this table cannot be migrated because this table is not among the specified data migration objects.

A wildcard is a short text that represents a group of paths. You can use a wildcard as an elementary regular expression. When you create a data migration project, you can configure data migration objects based on wildcard rules. For more information, see the "Wildcard rules" section in this topic.

OMS Community Edition allows you to configure object migration and exclusion rules for all types of data migration projects. Object migration and exclusion rules apply in all stages of a data migration project. Object migration and exclusion rules take effect on a data migration project only if you configure or update the rules before the project starts.

Notice

If you select DDL Synchronization when you create a data migration project, you must configure the data migration objects based on wildcard rules.

When you use wildcards to configure object migration and exclusion rules during the creation of a data migration project, you can:

  • Specify the migration objects by configuring wildcard rules.

  • Edit and verify the matching rules, and preview matched objects.

  • View the differences between objects before and after a wildcard rule is updated.

  • You can configure database name mappings and table name mappings based on wildcard rules.

Limits

  • You must specify an object migration rule for tables.

  • If you configure multiple schemas to match one type of objects in a rule, reverse incremental synchronization is not supported.

  • If multi-table aggregation is enabled, reverse incremental synchronization is not supported.

  • If DML filtering is enabled, full data verification is not supported.

  • You cannot perform DDL operations on the source database during the period between schema migration and full migration.

  • You can configure object migration and exclusion rules to match schemas and tables, but not to synchronize DDL operations.

  • You cannot change a table name that matches the object exclusion rule to a name that does not match the object exclusion rule by using a DDL operation.

  • If you use gh-ost to synchronize DDL operations for incremental migration from a MySQL database to OceanBase Community Edition, set Object Exclusion Rule to {database_name}.*_ghc.

Configure a matching rule

  1. Create a migration project.

    1. Log on to the OMS Community Edition console.

    2. In the left-side navigation pane, click Data Migration.

    3. On the Data Migration page, click Create Migration Project in the upper-right corner.

  2. On the Select Source and Destination page, configure the parameters. For more information, see the procedure for creating a data migration project of the corresponding type.

    Parameter Description
    Migration Project Name We recommend that you set it to a combination of Chinese characters, digits, and letters. It must not contain any spaces and cannot exceed 64 characters in length.
    Label Click the field and select the target tag from the drop-down list. You can click Manage Tags to create, modify, and delete tags. For more information, see Use tags to manage data migration projects.
    Source Select a created source data source.
    Destination Select a created destination data source.
  3. Click Next.

  4. (Optional) In the dialog box that appears, click OK.

  5. On the Select Migration Type page, specify related parameters.

  6. (Optional) Click Next.

  7. Click Next. On the Select Objects page, select the migration objects and migration scope.

    You can select one of the following two modes to migrate objects: Specify Objects or Match Rules. This section describes how to configure a matching rule.

    1. Select Match Rules.

    2. In the Specify Migration Scope section, specify object migration rules in the Object Migration Rule field and object exclusion rules in the Object Exclusion Rule field. The Object Exclusion Rule field is optional. For more information about supported matching rules, see the "Wildcard rules" section in this topic.

      Notice

      If you use gh-ost to synchronize DDL operations for incremental migration from a MySQL database to OceanBase Community Edition, Object Exclusion Rule is required. Set it to {database_name}.*_ghc.
      Pay attention to the privilege settings of the source database user. If you do not grant all required privileges to the migration user, some objects are not displayed in the frontend by OMS Community Edition, and you cannot correctly configure matching rules. In this case, you need to add these objects to Object Exclusion Rule to prevent the data migration project from being interrupted because OMS Community Edition cannot find the target objects.

      After you specify the migration object rule and object exclusion rule, you can view the migratable objects and matching results on the right side. The matching results are displayed on the Final Objects, New Object, and Removed Objects tabs. The wildcard rules and exclusion rules apply to tables and views.

      You can also rename an object. Specifically, on the Final Objects tab, hover the pointer over the target object, click Rename, enter the new name, and click OK to rename the target object.

    3. Click Verify and Preview Objects.

  8. After the verification succeeds, click Next.

  9. On the Migration Options page, configure the parameters. For more information, see the procedure for creating a data migration project of the selected migration type.

  10. Click Precheck to start a precheck on the data migration project.

  11. Click Start Project.

Wildcard rules

The wildcard rules supported by OMS Community Edition include "*", "?", "[]", and "[!]". Each rule occupies a single row and spaces are not allowed before or after a rule.

After you configure the object migration and exclusion rules, a new table created in the source database can be synchronized by OMS Community Edition in real time if the table name matches the migration rule and does not match the exclusion rule.

The rules to include or exclude migration objects are case-sensitive. A rule is hit only when the object name exactly matches the rule, including the case.

Asterisk (*)

You can use an asterisk to match a string of characters in any length, or a null character. You can also use an asterisk to select all objects in a database or schema. For example, if you set Object Migration Rule to <Schema>.*, all tables and views in the specified schema are displayed on the Matching Result tab in the right-side panel.

In the Object Exclusion Rule field, you can set the objects that do not need to be migrated, and then click Verify. After verification is passed, click Preview Objects and view the objects on the Matching Result tab.

Question mark (?)

You can use a question mark to match a single character. To match more than one character, use multiple consecutive question marks. You can also use a question mark to select the objects in a database or schema that meet specified conditions. For example, if you set Object Migration Rule to <Schema>.t?, tables and views that conform to the format in the specified schema are displayed on the Matching Result tab in the right-side panel.

Notice

You cannot use a question mark to match a null character. In other words, the place held by the question mark must have a character.

In the Object Exclusion Rule field, you can set the objects that do not need to be migrated, and then click Verify. After verification is passed, click Preview Objects and view the objects on the Matching Result tab.

Square brackets ([])

You can use a pair of square brackets to include any characters that must be matched, or use [start-end] to match a continuous range. For example, if you set Object Migration Rule to <Schema>.[]*, tables and views that conform to the format in the specified schema are displayed on the Matching Result tab in the right-side panel.

In the Object Exclusion Rule field, you can set the objects that do not need to be migrated, and then click Verify. After verification is passed, click Preview Objects and view the objects on the Matching Result tab.

An exclamation point in square brackets ([!])

You can use this wildcard rule to match any non-null characters that are not included in the square brackets, or use [!start-end] to indicate a continuous range. For example, if you set Object Migration Rule to <Schema>.[!]*, tables and views that conform to the format in the specified schema are displayed on the Matching Result tab in the right-side panel.

In the Object Exclusion Rule field, you can set the objects that do not need to be migrated, and then click Verify. After verification is passed, click Preview Objects and view the objects on the Matching Result tab.

Previous topic

Supported DDL operations in incremental migration between MySQL tenants of OceanBase Database
Last

Next topic

Data synchronization overview
Next
What is on this page
Background
Limits
Configure a matching rule
Wildcard rules
Asterisk (*)
Question mark (?)
Square brackets ([])
An exclamation point in square brackets ([!])