OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Migration Service

V3.3.1Community Edition
  • Product updates
  • Product Introduction
    • What is OMS Community Edition?
    • Architecture
      • Overview
      • Hierarchical functional system
      • Basic components
    • Limits
    • Terms
  • Deployment Guide
    • Overview
    • System requirements
    • Resource configuration specifications
    • Prepare the environment
    • Deploy a time-series database (Optional)
    • 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
    • Check the deployment
    • Scale out OMS Community Edition
  • User Guide
    • OMS Community Edition console
      • Log on to the OMS Community Edition console
      • Overview
      • User center
        • Configure user information
        • Change your logon password
        • Log off
    • Users and privileges
      • Create a database user
      • User privileges
      • Enable binlogs for the MySQL database
    • Manage data sources
      • Add a data source
        • Add an OceanBase Community Edition data source
        • Add a MySQL data source
        • Add a TiDB data source
        • Add a Kafka data source
        • Add a RocketMQ data source
      • View data source information
      • Copy a data source
      • Edit a data source
      • Delete a data source
    • Data migration
      • Overview
      • Supported DDL operations for incremental migration and limits
      • Create a data migration project
        • Create a project to migrate data from a MySQL database to OceanBase database Community Edition
        • Create a project to migrate data from OceanBase database Community Edition to a MySQL database
        • Migrate data within OceanBase database Community Edition
        • Create an active-active disaster recovery project in OceanBase database Community Edition
        • Create a project to migrate data from a TiDB database to OceanBase database Community Edition
      • Manage data migration projects
        • View details of a data migration project
        • Start, pause, and resume a data migration project
        • Release a data migration project
        • Delete a data migration project
        • Use tags to manage data migration projects
        • Download and import the settings of migration objects
      • Configure matching rules for migration objects
    • Data synchronization
      • Overview
      • Data formats
      • Create a data synchronization project
        • Create a project to synchronize data from an OceanBase database Community Edition to a Kafka instance
        • Create a project to synchronize data from an OceanBase database Community Edition to a RocketMQ instance
      • Manage data synchronization projects
        • View details of a data synchronization project
        • Start, pause, and resume a data synchronization project
        • Release and delete a data synchronization project
        • Use tags to manage data synchronization projects
        • Download and import the settings of synchronization objects
    • OPS & Monitoring
      • Go to the overview page
      • Server
        • View server information
        • Update the quota
        • View server logs
        • Paths of component 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 about 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 details of a checker
          • Start and pause a checker
          • Rerun and recover a checker
          • Update the configurations of a checker
          • Delete a checker
      • O&M ticket
        • View details of an O&M ticket
        • Skip a ticket or sub-ticket
        • Retry a ticket or sub-ticket
      • Component parameters
        • Store parameters
          • Parameters of a MySQL store
          • Parameters of an OceanBase store
        • Connector parameters
          • Parameters of a destination RocketMQ instance
          • Parameters of a DataflowSink instance
          • Parameters of a destination Kafka instance
          • Parameters of a source database in full migration
          • Parameters for intermediate-layer synchronization
        • JDBCWriter parameters
        • Checker parameters
    • System management
      • User management
      • Alert center
        • View project alerts
        • View system alerts
        • Manage alert settings
      • Associate with OCP
      • System Parameters
        • Modify system parameters
        • Modify HA configurations
  • 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
  • API Reference
    • Obtain the status of a migration project
    • Obtain the status of a synchronization project
  • Upgrade Guide
    • Overview
    • Upgrade OMS Community Edition in single-node deployment mode
    • Upgrade OMS Community Edition in multi-node deployment mode
    • FAQ

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Migration Service
  3. V3.3.1

JDBCWriter parameters

Last Updated:2026-09-04 08:14:02

Coordinator
Destination
Source
Forward-compatible parameters

Coordinator

Parameter
Required
Default value
Description
destSubId No None The sub-ID of the destination database.
daemonIp No None The service IP address of the JDBCWriter.
daemonPort No None The service port of the JDBCWriter.
sourceType No None The type of the source database.
destSubTopic No None The topic ID of the destination database.
sinkType No None The type of the destination database.
useTxId No None Specifies whether to use a transaction ID.
antiLoopMode No None Specifies whether to enable the anti-loop mode for the transaction table.
obHiddenPrimaryKeySyncDestColumn No OMS_PK_INCRMT The name of a column into which a hidden column in OceanBase Database is converted.
isReverse No false Specifies whether the link is a reverse link.
skipDdl No None The DDL statements to be skipped.
skipDDLSeparator No & The separator for separating the DDL statements to be skipped.
filterComment No false Specifies whether to filter comments in DDL statements.
isCaseSensitive No false Specifies whether to enable case sensitivity.
mysqlVersion No None The MySQL version of the source database.
noPkOrUkAllowed No true Specifies whether to support synchronization without a primary key (PK) or a not-null unique key (UK). It is the main control parameter. The value is subject to the types of the source and destination databases.

Destination

Parameter
Required
Default value
Description
txnTable No None The transaction table that prevents cyclical replication and use.
txnDb No None The database in which the transaction table that prevents cyclical replication and use is located.
jdbcUrl No None The connection string of the destination database.
username No None The username of the account for accessing the destination database.
password No None The password of the account for accessing the destination database.
printSql No false Specifies whether to print executed SQL statements.
workerNum No 16 The number of parallel write threads in the database. The value can be optimized based on the number of server cores and the number of database connections.
slowSqlThreshold No None The execution duration threshold above which an SQL statement is considered a slow SQL statement.
timezone No None The time zone set in the session when data is written to OB10 or MySQL, for example, +08:00. This parameter is required to ensure the correctness of data when Unix timestamp data is output as data in the date format for synchronization.
localRegionNo No None The number of the target region, which is used to prevent cyclical replication.
notWriteColumn No None The column to which no data needs to be written.
transactionIdIsLong No None Specifies whether the transaction ID needs to be converted into the long type before it is written into the database. This parameter is used for compatibility with existing transaction tables.
useTargetIndex No false Specifies whether to use indexes of the destination database for data synchronization.

Source

Parameter
Required
Default value
Description
cmUrl No None The address of the cluster manager, which is used to obtain the connection to a store.
useDRCNet No false Specifies whether to use DRCNet as the transmission protocol. Set this parameter to true to improve the transmission performance.
storeUsername No None The username of the store.
storePassword No None The password of the store.
srcSubTopic No None The topic for pulling data from the store.
blackRegionNo No None The number of the region that is not involved in data migration, which is used to prevent cyclical replication.
drcMarkTable No None The transaction table that prevents cyclical replication and use.
drcMarkDb No None The database in which the transaction table that prevents cyclical replication and use is located.
ignoreDdl No None Specifies whether to ignore DDL statements.
askSelfUnit No false The value false indicates that all incremental data is to be pulled. The value true indicates that only data written by business is to be pulled. Set this parameter to true in active-active scenarios.
timestamp No None The point in time for connecting to the store. It is a second-level timestamp.
splitThreshold No 16384/workerNum The threshold for splitting a large transaction.

Forward-compatible parameters

Parameter
Required
Default value
Description
src_type No None The type of the source database. Valid values: mysql, oceanbase (OB05), oceanbase1 (a MySQL tenant of OceanBase Database).
dest_type No None The type of the destination database. Set this parameter to the same value as that of src_type.
retry_time No 10000 The number of retries allowed during data synchronization. The value is of the INT type.
retry_sleep No None The retry interval during data synchronization, in seconds. The value is of the INT type.
lsn_mode No false Specifies whether to enable the anti-replay logic. The value is of the Boolean type.
tx_records_limit No 8192 The shard size for sharding a large transaction. The value is of the INT type.
cluster.url No None The address of the cluster manager, which is used to connect to the source store.
config_url No None The Java Database Connectivity (JDBC) URL of the destination database.
binlog_username No None The username of the account for connecting to the source store.
binlog_password No None The password of the account for connecting to the source store.
timestamp No None The timestamp of the point in time when data is pulled from the store.
src_subTopic No None The subtopic for connecting to the source store.
ignore_ddl No true Specifies whether to enable DDL synchronization. Valid values: true and false.
  • true: DDL synchronization is disabled.
  • false: DDL synchronization is enabled.
filter.db and filter.table No * The transaction table that prevents cyclical replication and use. filter.db is invalid when data is written to an OB05 database. In this case, filter.table of the migration user is used instead.
filter.table No drc_txn The transaction table that prevents cyclical replication and use. filter.db is invalid when data is written to an OB05 database. In this case, filter.table of the migration user is used instead.
worker_num No 64 The number of parallel write threads in the database. The value can be optimized based on the number of server cores and the number of database connections.

Previous topic

Parameters for intermediate-layer synchronization
Last

Next topic

Checker parameters
Next
on this page
Coordinator
Destination
Source
Forward-compatible parameters