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.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

OMS Documentation What is OMS? Terms OMS HA Overview Hierarchical functional system Basic components OMS Oracle full data migration design and impact Limitations Data migration process Data synchronization process 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) Log on to the OMS console Overview Configure user information Change your logon password Log off 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 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 Synchronize DDL operations from a MySQL tenant of OceanBase Database to a MySQL database 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 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 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 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 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 O&M overview Go to the overview page View server information Update the quota View server logs View O&M tasks Skip a task or subtask Retry a task or subtask
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.2.3
iconOceanBase Migration Service
V 4.2.3Enterprise 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

Store parameters

Last Updated:2025-05-28 09:46:28  Updated
share
What is on this page
Common parameters
Parameters of an OceanBase store
Parameters of a MySQL store
Parameters of an Oracle store
Parameters of a DB2 store
Parameters of a PostgreSQL store

folded

share

OceanBase Migration Service (OMS) supports the following types of store components: MySQL, Oracle, OceanBase, DB2, and PostgreSQL. This topic introduces general parameters that are not specific to database types, as well as Store component parameters for different database types.

Common parameters

Parameter Required? Default value Description Applicable version
store.clearer.outdated Yes None The maximum period that a piece of data can be stored in the store component, in seconds. All versions
store.clearer.period Yes None The storage period of a piece of data in the store component, after which the data is cleared. Unit: seconds. All versions

Parameters of an OceanBase store

This topic describes the common parameters of an OceanBase store component. To modify parameters, log on to the OceanBase Migration Service (OMS) console, choose O&M and Monitoring > Component > Store, find the target component on the page that appears, and click Update in the Actions column to open the Update Configuration dialog box.

Note

All parameters of the OceanBase store component are in the liboblog section where all parameter names are prefixed with liboblog.. For example, the full name of the cluster_appname parameter is liboblog.cluster_appname.

Parameter Default value/Value range Description
cluster_url | The URL used by OBCDC to obtain RS information of an OceanBase cluster. Generally, the value is consistent with that of the obconfig_url parameter of the observer process.
cluster_user | The username of the user in the sys tenant. The user has the permission to read the oceanbase database.
cluster_password | The password for the user of the sys tenant.
tenant_endpoint | The information of the server that hosts a user tenant in the svr_ip:sql_port format.
tenant_user | The name of the tenant user. The user has the permission to read system tables.
tenant_password | The password of the tenant user.
cluster_id_black_list | For more information, see ob_org_cluster_id.
tb_white_list *.*.* The allowlist of tables to be synchronized, in the format of tenant name.database name.table name, such as mytenant1.db1.tb1\|mytenant2.db2.*. In tenant mode, you must specify the name of the tenant that you want to synchronize.

Notice

This parameter is invalid if you are using OceanBase V4.x.

tb_black_list | The blocklist of tables that will not be synchronized.

Notice

This parameter is invalid if you are using OceanBase V4.x.

working_mode storage/{storage,memory} The working mode. In storage mode, redo logs pulled by OBCDC are persisted into the specified directory of RocksDB, which is cleared when OBCDC is restarted.
fetching_log_mode integrated/{integrated,direct} The log pull mode. integrated indicates that the store component pulls logs from the server by using remote procedure calls (RPCs). direct indicates that the store component pulls logs by reading archive files.
archive_dest | The path of archive files if the direct mode is used. If archive files are stored on Alibaba Cloud Object Storage Service (OSS), you must also specify the AccessKey pair.
meta_data_refresh_mode online/{online,data_dict} The metadata source. online indicates that the schemas are constructed by reading internal tables through SQL queries. data_dict indicates that the schemas are constructed by using data dictionaries in the logs.
skip_ob_version_compat_check 0/{0,1} Specifies whether to ignore the version check.
  • Set this parameter to 1 when you must use OceanBase CDC of an earlier version to synchronize data from OceanBase Database of a later version, which is not recommended.
  • By default, OceanBase CDC uses data dictionaries when it synchronizes data from OceanBase Database of a version later than V4.2. To enable the online mode, set this parameter to 1.
skip_delete_tablet_op 0/{0,1} If OceanBase CDC ignores DROP TABLE operations, some bypass import or offline DDL operations may cause the parser of OceanBase CDC to report an ENTRY_NOT_EXIST error. You can configure this parameter to skip the error in case of emergency. This parameter is available in OceanBase Database of a version later than V4.2.1 BP2.
skip_dirty_data 0/{0,1} You must specify this parameter when you synchronize data from OBKV or HBase.
skip_empty_outrow_lob_update 0/{0,1} Specifies whether OceanBase CDC ignores empty OUTROW LOB columns. You can configure this parameter in case of emergency.
lsn_black_list | Specifies the logs whose log sequence numbers (LSNs) are ignored.
sql_server_blacklist | The list of servers that are blocked from processing SQL queries. You must specify the information of each server in the svr_ip:rpc_port format.
server_blacklist | The list of servers that are blocked from processing RPC requests. You must specify the information of each server in the svr_ip:rpc_port format.
data_start_schema_version | The schema version, in the tenant_id:schema_version\|xxxx format, used to build schemas in OceanBase CDC.
timezone +8:00 The time zone used to process the time data that is written in the local time zone. The value must be the same as the local time zone used by the server where OceanBase Database is located. If the time zone is specified in a session and you want the value of this parameter to be consistent with the time zone in the session output, you can set this parameter to the time zone specified in the session.
region | The region from which logs are first pulled. The specified region must be obtained from the internal table of OceanBase Database.
memory_limit 8G/[2G, ) The maximum memory usage of OceanBase CDC. OceanBase CDC will control its memory usage near the specified value as much as possible.
memory_usage_warn_threshold 85 The memory percentage that triggers log pull throttling. The value is the ratio between the memory size already occupied by OceanBase CDC and the value of the memory_limit parameter.
pause_redo_dispatch_task_count_threshold 80 The ratio between the number and length of tasks in the USER_QUEUE or RESOURCE_COLLECTOR module. If the ratio exceeds the specified value, the pull of redo logs is throttled.
part_trans_task_active_count_upper_bound 0/[0, ) The maximum number of transactions allowed for all participants. The default value is 0, which indicates that OceanBase CDC automatically adjusts the maximum number of transactions. You can modify the value as needed. Like the memory_limit parameter, you can use this parameter for throttling control.
part_trans_task_reusable_count_upper_bound 0/[0, ) The maximum allowed number of reusable participant transactions. A reusable transaction is a processed transaction that can be consumed or recycled. The default value is 0, which indicates that OceanBase CDC automatically adjusts the maximum number of transactions. You can modify the value as needed. Like the memory_limit parameter, you can use this parameter for throttling control.
part_trans_task_prealloc_page_count 20000/[1, ) The maximum number of transactions of participants that can be cached. If you set the parameter to a larger value, the memory usage of OceanBase CDC may be very high during the idle period.
enable_hbase_mode 0/{0,1} Specifies whether to enable HBase mode. If a table in HBase mode is to be synchronized, you must enable HBase mode.
enable_compatible_charset 0/{0,1} Specifies whether to use character sets that are compatible with the data replication center (DRC) in the output.
enable_convert_timestamp_to_unix_timestamp 0/{0,1} Specifies whether to convert a timestamp to a UNIX timestamp. This parameter takes effect in a MySQL Tenant of OceanBase Database.
enable_oracle_mode_match_case_sensitive 0/{0,1} Specifies whether to enable case sensitivity for table names in the allowlist and blocklist of an Oracle tenant of OceanBase Database.
enable_output_by_table_def 0/{0,1} Specifies whether to sort the output columns in the user-defined order.
enable_output_hidden_primary_key 0/{0,1} Specifies whether to include hidden primary keys in the output.
enable_output_invisible_column 0/{0,1} Specifies whether to include invisible columns in the output.
fetch_log_rpc_timeout_sec 15/[1, ) The timeout period for log pull.
rs_sql_connect_timeout_sec 40/[1, ) The timeout period for connecting to the root server of the sys tenant. You can use online schema mode to obtain the timeout periods of SQL statements in a specified schema.
rs_sql_query_timeout_sec 30/[1, ) The timeout period for SQL queries processed on the root server.
tenant_sql_connect_timeout_sec 40/[1, ) The timeout period for connecting to an OBServer node of a user tenant.
tenant_sql_query_timeout_sec 30/[1, ) The timeout period for SQL queries processed in a user tenant.
max_log_file_count 40/[1, ) The maximum number of retained logs. The size of each log file is 256 MB.

Parameters of a MySQL store

Note

All parameters of a MySQL store component are in the mysql2store section where all parameters are prefixed with mysql2store.. For example, the full name of the xlogMode parameter is mysql2store.xlogMode.

Parameter Required? Default value Description Applicable version
xlogMode No true Specifies whether to parse incremental data of the source by using the new version of MySQL Reader. OceanBase Migration Service (OMS) V4.1.0 and later
useGtid No true Specifies whether to enable the global transaction identifier (GTID). If you set the parameter to true and the GTID is enabled in the source, the timestamp of binlog pull is located based on the GTID. OMS V4.1.0 and later
master.timestamp Yes None The start timestamp of binlog pull. By default, a new store component starts pulling with binlogs generated 10 minutes before it runs. For example, if a new store component starts running at 12:00, it pulls binlogs that have been generated since 11:50. Note that you cannot perform a DDL operation in the source data source between 11:50 and 12:00. All versions
master.host Yes None The IP address of the source database. All versions
master.port Yes None The port number of the source database. All versions
master.username Yes None The username used to connect to the source database. All versions
master.password Yes None The password used to connect to the source database. You must use this parameter with the master.username parameter. All versions
filter.conditions Yes *.* The delimiter between a database name and a table name in the allowlist for data parsing. You must separate multiple database.table name pairs with vertical bars (|). For example, a.b\|c.d indicates that only Table b in Database a and Table d in Database c are parsed. Note: If the source database is case sensitive, X.Y and X.y indicate that Table Y and Table y in Database X are parsed. All versions
filter.blacklist Yes Null The list of tables that are blocked from data parsing. You must separate multiple database tables with vertical bars (|). For example, a.b\|c.d indicates that Table b in Database a and Table d in Database c are filtered. Note: If the source database is case sensitive, X.Y and X.y indicate that Table Y and Table y in Database X are filtered out. All versions
max_landing_message_num No 40000 The maximuim number of messages waiting in the sending queue. If binlog files contain large fields, you must decrease the value of this parameter or increase the values of Java virtual machine (JVM) parameters of MySQL Reader. Otherwise, the out-of-memory (OOM) exception may be triggered. OMS V4.1.0 and later
subreader.jvm_param No -Xms2048m -Xmx2048m -Xmn1024m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=128m -XX:+UseConcMarkSweepGC -XX:+UseParNewGC -XX:+CMSParallelRemarkEnabled -XX:+UseCMSInitiatingOccupancyOnly -XX:CMSInitiatingOccupancyFraction=70 -XX:+CMSClassUnloadingEnabled The settings of Java virtual machine (JVM) parameters of MySQL Reader. OMS V4.2.2 and later
seek_start_position_timeout_millis No 600,000 The timeout period for identifying the MySQL file ID and offset based on the value of the master.timestamp parameter when the store component starts running. Unit: milliseconds. OMS V4.1.0 and later
connect_timeout_millis No 60,000 The timeout period for the store component to create a connection to the source database, in milliseconds. OMS V4.1.0 and later
socket_timeout_millis No 60,000 The timeout period for data read through a connection to the source database, in milliseconds. OMS V4.1.0 and later
ignore_xa_rollback No false Specifies whether to ignore the rollback of an XA transaction. OMS V4.1.0 and later
ignore_ddl_error No true Specifies whether to ignore DDL statement parsing errors. By default, the store component ignores DDL statement parsing errors, and exits when a DML statement parsing error occurs. OMS V4.1.0 and later
ignore_not_supported_ddl No true Specifies whether to ignore unsupported DDL statements. By default, unsupported DDL statements are ignored. If the DML statement parsing is affected after an unsupported DDL statement is ignored, the store component exits when a DML statement parsing error occurs. OMS V4.1.0 and later
schema_initial_parallel_num No A value that is twice the number of CPU cores or 4, whichever is smaller. The number of connections for concurrently pulling table schemas from the source database during initialization. OMS V4.1.0 and later
master.serverid Yes None The MySQL replication protocol requires that the server ID of the slave server must be specified when the slave server connects to the master server. MySQL Reader is a slave role. This parameter specifies the server ID of the slave MySQL Reader. All versions
master.uuid Yes None The MySQL replication protocol requires that the universally unique identifier (UUID) of the slave server must be specified when the slave server is connected to the master server. MySQL Reader is a slave role. This parameter specifies the UUID of the slave MySQL Reader. All versions
master.heartbeatperiod No 0.5 The interval at which the source database sends heartbeats when the binlog connection is idle, in milliseconds. All versions
master.maxdumper No 200 The maximum number of binlog dumper connections to the source database to check the workload of the source database. All versions
master.has_implicit_primary_key No true In RDS for MySQL, hidden columns are added to tables without a primary key. If you set the parameter to true, parsing of hidden columns is automatically ignored. All versions
master.binlog No Empty The binlog file ID that locates the start timestamp of binlog pull together with the master.offset parameter. This parameter is not used. When the store component starts running, it uses the master.timestamp parameter to locate the start timestamp of binlog pull. All versions
master.offset No Empty The offset that locates the start timestamp of binlog pull together with the master.binlog parameter. This parameter is not used. When the store component starts running, it uses the master.timestamp parameter to locate the start timestamp of binlog pull. All versions
Other parameters None None Parameters not described in this table are obsolete and are rarely used. If you need to modify these parameters, contact OMS Technical Support. -

Parameters of an Oracle store

Notice

All parameters of an Oracle store component are in the deliver2store section where all parameters are prefixed with logminer., unless otherwise specified. For example, the full name of the oracle.url parameter is logminer.oracle.url.

Parameter Required? Default value Description Applicable version
print_data No false Specifies whether to print the detailed change records pulled by LogMiner for data quality troubleshooting. OceanBase Migration Service (OMS) V1.3.2 and later
full_table_name_white_list Yes None The allowlist of tables accessible by the Store component. The table names in the allowlist must contain the full paths. You can use wildcards and specify multiple tables. Table names must be separated with vertical bars (|). For example, schema1.table*\|schema2.table1. OMS V3.1.0 and later
full_table_name_black_list Yes (nullable) None The blocklist. The table names in the blocklist must contain the full paths. You can use wildcards and specify multiple tables. Table names must be separated with vertical bars (|). For example, schema1.table*\|schema2.table1. OMS V3.1.0 and later
log_prepared_converter_queue_size No 20000 The number of logs in the queue prepared in the converter stage. OMS V3.2.0 and later
read_timeout_ms No
  • 180000 in OMS of a version earlier than V4.2.2.
  • 300000 in OMS V4.2.2 and later.
The timeout period for a read request to an Oracle database through a non-log-pull connection, in milliseconds. OMS V1.3.2 and later
fetch_log_read_timeout_ms No 1200000 The timeout period for a read request to an Oracle database through a log pull connection, in milliseconds. OMS V4.2.2 and later
max_fetch_log_read_timeout_ms No 2400000 The maximum timeout period for a read request to an Oracle database through a log pull connection, in milliseconds. The store component can automatically adjust the timeout for a log pull connection. OMS V4.2.2 and later
converter_thread_num No 8 The number of threads during the conversion phase. OMS V3.2.1 and later
use_independent_fetcher_per_instance No
  • false in OMS V2.2.0.
  • true in OMS V3.1.0 and later.
Specifies whether to use an independent fetcher module to pull transaction logs generated by each instance (thread) in the database. Default value: false.
  • If you set the value to false, the previous combined pull structure of OMS V1.x is used, which supports real application clusters (RACs) consisting of at most three instances.
  • If you set the value to true, the new independent pull structure is used, which supports RACs consisting of any number of instances and non-RAC structures including only one instance.
  • fetch_arch_logs_max_parallelism_per_instance, max_actively_staged_arch_logs_per_instance, enable_stage_queue_compression, and stage_queue_directory are valid only when this parameter is set to true.
OMS V2.2.0 and later
staged_arch_logs_in_memory No false Specifies whether to temporarily store the pulled logs in memory if parallel pull is enabled during the log pull phase. The default value false indicates that the pulled logs are temporarily stored in a local disk. OMS V2.2.0 and later
fetch_online_log_interval_seconds No
  • 5 in OMS V3.2.1 and later to a version earlier than V4.0.1.
  • 20 in OMS V4.0.1 and later.
The interval of pulling online logs, in seconds. OMS V3.2.1 and later
enable_flashback_query No
  • true in OMS V3.2.1 and V3.2.2.
  • false in OMS V3.3.0 and later.
Specifies whether to use flashback queries for table access. OMS V3.2.1 and later
need_all_column_data No true Specifies whether to pull all column data, which reduces unnecessary table access. This parameter applies only to data migration or synchronization between databases. OMS V3.3.0 and later
need_check_object_length No true Specifies whether to check the length of the object name, such as the schema name, table name, and column name. By default, the length of the object name cannot exceed 30 bytes. OMS V3.3.1 and later
analyser_thread_num No 4 The number of threads during the analysis phase. OMS V3.3.1 and later
analyser_batch_size No 1000 The maximum number of records processed in each parallel batch during the analysis phase. OMS V3.3.1 and later
instance_threads No Empty The ID of the thread that pulls instance logs. You must separate multiple thread IDs with vertical bars (|). For example, 1|2|3. OMS V3.3.1 and later
print_diagnose_info No false Specifies whether to print the diagnostic logs for data quality troubleshooting.
The amount of printed diagnostic logs is related to that of archive logs in the Oracle database. You need to pay attention to the disk usage.
OMS V3.4.0 and later
transaction_id_use_full_version No true Whether to use the complete transaction id as the basis during transaction-related processing. OMS V4.2.2 and later
enable_assist_fetch No
  • false in OMS V4.0.1 and V4.0.2.
  • true in OMS V4.1.0 and later.
Specifies whether LogMiner mines an auxiliary file that precedes the log of interest. OMS V4.0.1 and later
assist_fetch_fallback_scn No 1000 The number of the last SCNs to be mined by LogMiner in the auxiliary file that precedes the target log file. If you set the value to less than 0, LogMiner mines the entire auxiliary file that precedes the target log file. This parameter takes effect only if you set the enable_assist_fetch parameter to true. OMS V4.0.1 and later
enable_log_big_transaction No true Specifies whether to print the information about large transactions, such as the tables involved in a large transaction, and the number of changes per table. OMS V4.0.2 and later
big_transaction_threshold No 100000 If the number of changes involved in a transaction exceeds the value of this parameter, the transaction is a large transaction. This parameter takes effect only if you set the enable_log_big_transaction parameter to true. OMS V4.0.2 and later
big_transaction_top_table No 10 The number of tables that involve the most changes and whose information is printed in descending order based on the number of changes in each table. This parameter takes effect only if you set the enable_log_big_transaction parameter to true. OMS V4.0.2 and later
enable_level_store No
  • false in OMS V4.0.2.
  • true in OMS V4.1.0 and later.
Specifies whether to use a new storage layer to cache concurrently pulled logs and large transactions during log pull. OMS V4.0.2 and later
level_store_block_size No 8192 The size of a block of a new storage layer. OMS V4.0.2 and later
level_store_data_threshold No 1000 The number of changes involved in a transaction that triggers a data dump from a new storage layer to a disk. OMS V4.0.2 and later
level_store_pool_size No 100 The number of blocks in the memory pool of a new storage layer. OMS V4.0.2 and later
level_store_memory_record_limit No 1000 The maximum number of data records in the memory of a new storage layer. This parameter prevents full memory usage when the speed of data dump to a disk is much lower than that of data insertion to the memory. OMS V4.0.2 and later
use_rsid_instead_of_xid No true Specifies whether to replace the generated transaction ID with an RSID. OMS V4.2.2 and later
ignore_unused_commit_rollback No true Specifies whether to ignore some useless commit or rollback operation. OMS V4.2.2 and later
deliver2store.subreader.jvm_param No -Xms8g -Xmx8g -Xmn2g -XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:+DisableExplicitGC The settings of Java virtual machine (JVM) parameters of LogMiner Reader. Note that the full parameter name is deliver2store.subreader.jvm_param. OMS V4.2.2 and later

Parameters of a DB2 store

Parameter Required? Default value Description Applicable version
deliver2store.logminer.fetcherRetryCodes No -1018,-1024 The error code of a log pull operation that can be retried. You must separate multiple error codes with commas (,). OceanBase Migration Service (OMS) V3.2.1 and later
deliver2store.logminer.initialTimestamp No Current time The timestamp when the store component starts processing a heartbeat or DDL statement without having processed a DML statement. OMS V3.2.1 and later
deliver2store.logminer.db2EnableQueryBack No true Specifies whether to use table access. OMS V3.2.1 and later
deliver2store.logminer.localEndianName No big for an Advanced Interactive eXecutive (AIX) system. little for other systems. Specifies to parse logs in big-endian or little-endian mode. If you set the value to big (case-insensitive), logs are parsed in big-endian mode. Otherwise, logs are parsed in little-endian mode. OMS V3.2.1 and later
deliver2store.subreader.jvm_param No -Xms8g -Xmx8g -Xmn2g -XX:+UseG1GC -XX:MaxGCPauseMillis=20 -XX:InitiatingHeapOccupancyPercent=35 -XX:+DisableExplicitGC The settings of Java virtual machine (JVM) parameters of DB2 Reader. OMS V4.2.2 and later

Parameters of a PostgreSQL store

Note

All parameters of a PostgreSQL store component are in the deliver2store section where all parameter names are prefixed with postgresql., unless otherwise specified. For example, the full name of the publication_name parameter is deliver2store.postgresql.publication_name.

Parameter Required? Default value Description Applicable version
publication_name Yes None The unique name of the publication. This parameter is automatically specified when the project is started. OMS V3.4.0 and later
slot_name Yes None The unique name of the publication replication slot. This parameter is automatically specified when the project is started. OMS V3.4.0 and later
archive_log_keep_seconds No 172800 The retention period of replication slot logs, in seconds. OMS V3.4.0 and later
notify_confirmed_flush_lsn_interval_seconds No 600 The interval for the submission of log consumption checkpoints, in seconds. OMS V3.4.0 and later
connect_timeout_seconds No 180 The timeout period for connecting to the PostgreSQL database. OMS V3.4.0 and later
read_timeout_seconds No 600 The timeout period for data read through a connection to the PostgreSQL database. OMS V3.4.0 and later
print_detail_msg_log No false Specifies whether to print log details. OMS V3.4.0 and later
ignore_not_supported_ddl No true Specifies whether to ignore the DDL statements that cannot be parsed. OMS V4.2.2 and later
skip_ddl No [] The DDL statements that are not to be parsed. For example, ["create table t(c1 int)","create table t2(c1 int)"]. The value is case sensitive. On the parameter configuration page, double quotation marks (") in the value must be escaped. OMS V4.2.2 and later
data_type_mapping No {} The mapping logic of data types. For example, {"smallint":"int2","int4":"integer"}. On the parameter configuration page, double quotation marks (") in the value must be escaped. OMS V4.2.2 and later
reconnect_retry_interval_ms No 10000 The interval between connection retries. OMS V4.2.2 and later
host Yes 127.0.0.1 The IP address of the PostgreSQL database. OMS V3.4.0 and later
port Yes 5432 The port of the PostgreSQL database. OMS V3.4.0 and later
database Yes None The name of the database in the PostgreSQL instance. OMS V3.4.0 and later
username Yes None The username. OMS V3.4.0 and later
password Yes None The password that you use to log on to the database. OMS V3.4.0 and later
blacklist No None The list of tables that are not to be migrated. OMS V3.4.0 and later
whitelist Yes None The list of tables to be migrated. OMS V3.4.0 and later
table_name_cache_size No 10000 The maximum number of table names that can be cached in the filter. OMS V3.4.0 and later
table_name_expire_seconds No 600 The validity period of table names cached in the filter. OMS V3.4.0 and later
start_position No None The start timestamp. OMS V3.4.0 and later
fetch_all_table_metas No true Specifies whether to load the metadata of all tables. OMS V4.0.1 and later
schema_initial_parallel_mode No SCHEMA_LEVEL_PARALLEL The level of concurrent metadata loading. The value is case insensitive. Valid values: NO_PARALLEL、SCHEMA_LEVEL_PARALLEL, and TABLE_LEVEL_PARALLEL. OMS V4.0.1 and later
schema_initial_parallel_num No 4 The number of concurrent metadata loading threads. OMS V4.0.1 and later
schema_initial_batch_size No 100 The number of tables loaded by a concurrent thread at a time. OMS V4.0.1 and later
long_transaction_detect_period_seconds No 5 The interval for detecting whether a large transaction exists. OMS V4.1.0 and later
long_transaction_threshold_seconds No 600 If the execution of a transaction exceeds the specified period, the transaction is a large transaction. OMS V4.1.0 and later
level_store_record_threshold_num No 1000 The maximum number of transactions that can be stored in the layered storage in memory. OMS V4.1.0 and later
level_store_block_size No 8192 The size of a block of a new storage layer. OMS V4.1.0 and later
level_store_pool_size No 100 The number of blocks in the memory pool of a new storage layer. OMS V4.1.0 and later
jvm_param No -Xms2048m -Xmx2048m -Xmn1024m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=128m -XX:+UseConcMarkSweepGC -XX:+UseParNewGC -XX:+CMSParallelRemarkEnabled -XX:+UseCMSInitiatingOccupancyOnly -XX:CMSInitiatingOccupancyFraction=70 -XX:+CMSClassUnloadingEnabled The settings of Java virtual machine (JVM) parameters. The full parameter name is deliver2store.subreader.jvm_param. OMS V4.2.2 and later

Previous topic

Delete a component template
Last

Next topic

Incr-Sync parameters
Next
What is on this page
Common parameters
Parameters of an OceanBase store
Parameters of a MySQL store
Parameters of an Oracle store
Parameters of a DB2 store
Parameters of a PostgreSQL store