OceanBase logo

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

Product Overview
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

OceanBase

A unified distributed database ready for your transactional, analytical, and AI workloads.

Product Overview
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.2.4Community Edition

  • OMS Documentation
  • What's New
  • OMS Community Edition Introduction
    • What is OMS Community Edition?
    • Terms
    • OMS Community Edition HA
    • Architecture
      • Hierarchical functional system
      • Overview
      • 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 between instances 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
    • 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 the details of a data migration task
      • Perform batch operations on data migration tasks
    • Features
      • Rename a database table
      • Schema migration mechanisms
      • Create and update a heartbeat table
      • Configure matching rules for migration objects
      • DML filtering
      • DDL synchronization
      • Schema migration operations
      • Use SQL conditions to filter data
      • Wildcard rules
      • Set an incremental synchronization timestamp
      • Direct load
    • 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 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 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 RocketMQ data source
      • Create a TiDB data source
      • Create a PostgreSQL data source
      • Create an HBase data source
      • Create a Kafka data source
      • Create an OceanBase-CE data source
      • Create a MySQL 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
  • 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
    • 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 parameters
      • Coordinator
      • Condition
      • Source Plugin
        • Overview
        • StoreSource
        • DataFlowSource
        • LogProxySource
        • KafkaSource (TiDB)
        • HBaseSource
      • Sink Plugin
        • Overview
        • JDBC-Sink
        • KafkaSink
        • DatahubSink
        • RocketMQSink
        • HBaseSink
      • Store parameters
        • Parameters of a MySQL store
        • Parameters of an OceanBase store
      • Parameters of the CM component
      • Parameters of the Supervisor component
      • Parameters of the Full-Verification component
    • 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
      • DescribeProjectStepMetric
      • ListProjectFullVerifyResult
      • UpdateFullVerification
      • DeleteProject
      • ResumeProject
      • DescribeProject
      • CreateMysqlDataSource
      • CreateOceanBaseDataSource
      • CreateLabel
      • ListAllLabels
      • UpdateIncrSync
      • DescribeProjectSteps
      • ListDataSource
      • ListFullVerifyInconsistenciesResult
      • StartProjectsByLabel
      • ReleaseProject
      • StartProject
      • DescribeProjectProgress
      • StopProjectsByLabel
      • DescribeProjectComponents
      • CreateProject
      • UpdateStore
      • CreateMySQLMasterSlaveDataSource
    • 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
    • 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
      • 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
      • Switch to the standby database
      • How do I upgrade CDC?
      • How do I upgrade Store?

Download PDF

OMS Documentation What's New What is OMS Community Edition? Terms OMS Community Edition HA Hierarchical functional system Overview Basic components Limitations Data migration process Data synchronization process 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) Overview Log on to the console of OMS Community Edition Change your logon password Log off Configure user information 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 between instances 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 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 the details of a data migration task Perform batch operations on data migration tasks Rename a database table Schema migration mechanisms Create and update a heartbeat table Configure matching rules for migration objects DML filtering DDL synchronization Schema migration operations Use SQL conditions to filter data Wildcard rules Set an incremental synchronization timestamp Direct load Supported DDL operations in incremental migration between MySQL tenants of OceanBase Database 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 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 DML filtering DDL synchronization Configure matching rules for synchronization objects Rename a topic Use SQL conditions to filter data Column filtering Data formats 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 an OceanBase-CE data source Create a MySQL data source 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 O&M overview Go to the overview page Update the quota View server logs View server information View O&M tasks Skip a task or subtask Retry a task or subtask Overview Manage users Manage departments Manage alert settings
OceanBase logo

The Unified Distributed Database for the AI Era.

Follow Us
Products
OceanBase CloudOceanBase EnterpriseOceanBase Community EditionOceanBase seekdb
Resources
DocsBlogLive DemosTraining & CertificationTicket
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.2.4
iconOceanBase Migration Service
V 4.2.4Community Edition
Databases
  • OceanBase Database
  • OceanBase Cloud
  • OceanBase Tugraph
  • Interactive Tutorials
  • OceanBase Best Practices
Tools
  • OceanBase Cloud Platform
  • OceanBase Migration Service
  • OceanBase Developer Center
  • OceanBase Migration Assessment
  • OceanBase Admin Tool
  • OceanBase Loader and Dumper
  • OceanBase Deployer
  • Kubernetes operator for OceanBase
  • OceanBase Diagnostic Tool
  • OceanBase Binlog Service
Connectors and Middleware
  • OceanBase Database Proxy
  • Embedded SQL in C for OceanBase
  • OceanBase Call Interface
  • OceanBase Connector/C
  • OceanBase Connector/J
  • OceanBase Connector/ODBC
  • OceanBase Connector/NET
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.13
  • 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

Parameters of a MySQL store

Last Updated:2026-04-14 07:41:43  Updated
Share
What is on this page
Share
Parameter
Required?
Default value
Description
error.skipDDL Yes false Specifies whether to skip error detection when the metadata builder is enabled.
filter.allowedtypes Yes "" The allowed DDL types. An asterisk (*) indicates that any type is allowed. Multiple types are separated with vertical lines ( ).
filter.blacklist Yes "" The blacklist, where wildcards are separated with vertical lines ( ). Only the *.*, dbName.*, or dbName.tableName format is supported.
filter.conditions No None The whitelist, where wildcards are separated with vertical lines ( ). Only the *.*, dbName.*, or dbName.tableName format is supported.
filter.ddl Yes "" The supported DDL statements.
filter.ddlblacklist Yes "" The DDL blacklist.
filter.ddlwhitelist Yes "" The DDL whitelist.
filter.delim No None The separator for filter-related parameters.
master.addr_list Yes "" The address of the source MySQL Server, in the format of ip:port.
master.errorretry No None The maximum number of retries upon readBinlog errors.
master.fatalretry No None The maximum number of retries upon readBinlog critical errors.
master.fuzzymatch Yes false Specifies whether to enable fuzzy match for the Binlog Reader.
master.heartbeatperiod No None The heartbeat period of the Binlog Reader, which is a floating-point number.
master.host No None The host IP address of the source MySQL server.
master.maxdumper Yes None The maximum number of Binlog Dumpers in the source database.
master.password Yes "" The password of the account for accessing the source MySQL server.
master.port No None The listening port of the source MySQL server.
master.readtimeout Yes 1 The read timeout period of the Binlog Reader.
master.serverid No None According to the MySQL replication protocol, the server ID of the slave server must be set when the slave server connects to the master server. mysqlreader is a slave role. master.serverid indicates the server ID of the slave MySQL Reader.
master.timeoutretry Yes 86400 The timeout period for pulling logs from the source database.
master.timestamp No None The timestamp starting from which logs are pulled from the source database.
master.username Yes "" The username of the account for accessing the source MySQL server.
master.uuid No None According to the MySQL replication protocol, the universally unique identifier (UUID) of the slave server must be set when the slave server connects to the master server. mysqlreader is a slave role. master.uuid indicates the UUID of the slave MySQL Reader.
metabuilder.backupcycle Yes 12 The time interval at which the Metadata Builder backs up metadata, in hours.
metabuilder.expirestime Yes 504 The retention period of metadata files in the Metadata Builder, in hours. Files that have been stored for longer than this period will be deleted.
metabuilder.filter Yes "" Specifies whether the Metadata Builder filters data.
metabuilder.numOfThreads No None The number of threads in the metadata generation process.
metabuilder.retrytype Yes 2003, 2013, and 2006 The error codes that trigger a retry when the Metadata Builder connects to the database.
parallelism No None The queue capacity in pipelines.
pipeline Yes "" The pipeline process. A process includes multiple steps, and each step includes multiple operations. Each step is handled by a thread. Steps are separated with vertical lines ( ), and operations in a step are separated with commas (,).
rep.heartbeat.db No drc The name of the heartbeat database.
rep.heartbeat.table No heartbeat The table name of the heartbeat connection.
store_bind_address No None The host IP address of the store.

Previous topic

HBaseSink
Last

Next topic

Parameters of an OceanBase store
Next