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

V4.2.0Community Edition
  • OMS Documentation
  • What's New
  • OMS Community Edition Introduction
    • What is OMS Community Edition?
    • Terms
    • OMS Community Edition HA
    • Architecture
      • Overview
      • Hierarchical functional system
      • Basic components
    • Limits
  • Quick Start
    • Data migration process
    • Data synchronization process
  • Deploy OMS Community Edition
    • Deployment modes
    • 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 on multiple nodes in multiple regions
    • Scale out OMS Community Edition
    • Check the deployment
    • Deploy a time-series database (Optional)
  • OMS Community Edition console
    • Log on to the OMS Community Edition console
    • Overview
    • User center
      • Configure user information
      • Change your logon password
      • Log off
  • Data migration
    • Overview
    • Migrate data from a MySQL database to OceanBase Database Community Edition
    • Migrate data from OceanBase Database Community Edition to a MySQL database
    • Migrate data from HBase to OBKV
    • Migrate data within OceanBase Database Community Edition
    • Active-active disaster recovery within OceanBase Database Community Edition
    • 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 projects
      • View details of a data migration project
      • Change the name of a data migration project
      • View and modify migration objects
      • Manage computing platforms
      • 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
    • Features
      • DML filtering
      • DDL synchronization
      • Configure matching rules for migration objects
      • Wildcard rules
      • Rename a database table
      • Use SQL conditions to filter data
      • Create and update a heartbeat table
      • Schema migration mechanisms
      • Schema migration operations
      • Set an incremental synchronization timestamp
    • Supported DDL operations in incremental migration and limits
      • DDL synchronization from MySQL database to OceanBase Community Edition
        • Overview of DDL synchronization from a MySQL database to a MySQL 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 MySQL database and OceanBase Community Edition
          • 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
      • 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
  • 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
      • 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
    • Features
      • DML filtering
      • DDL synchronization
      • Rename a topic
      • Use SQL conditions to filter data
      • Column filtering
      • 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
      • Create an HBase 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 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
  • 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
    • 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
    • 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
    • Set throttling
  • Reference Guide
    • API Reference
      • Overview
      • CreateProject
      • StartProject
      • StopProject
      • ResumeProject
      • ReleaseProject
      • DeleteProject
      • ListProjects
      • DescribeProject
      • DescribeProjectSteps
      • DescribeProjectStepMetric
      • DescribeProjectProgress
      • DescribeProjectComponents
      • ListProjectFullVerifyResult
      • StartProjectsByLabel
      • StopProjectsByLabel
      • CreateMysqlDataSource
      • CreateOceanBaseDataSource
      • ListDataSource
      • CreateLabel
      • ListAllLabels
      • ListFullVerifyInconsistenciesResult
      • ListFullVerifyCorrectionsResult
      • UpdateStore
      • UpdateFullImport
      • UpdateIncrSync
      • UpdateFullVerification
    • 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?
      • Deploy InfluxDB for OMS
      • Increase the disk space of the OMS host
    • 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
        • 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?
    • Installation and deployment
      • How do I upgrade Store?
      • How do I upgrade CDC?
      • What do I do when the "Failed to fetch" error is reported?

Download PDF

Document Feedback
  1. Documentation Center
  3. OceanBase Migration Service
  5. V4.2.0

JDBC-Sink

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

Starter class
[Cyclical replication prevention] txnTable
[Cyclical replication prevention] txnDb
[Connection information] jdbcUrl
[Connection information] username
[Connection information] password
[Debugging] printSql
[Threads] workerNum
[Debugging] slowSqlThreshold
[Connection information] timezone
[Filtering] notWriteColumn
[Cyclical replication prevention] localRegionNo
[Reverse anti-replay] transactionIdIsLong
[Writing] useTargetIndex
[Writing to partitions in OceanBase Database] sysUsername
[Writing to partitions in OceanBase Database] sysPassword
[Writing to partitions in OceanBase Database] sysInstance
[Writing to partitions in OceanBase Database] tenant
[Writing to partitions in OceanBase Database] enablePartitionBucket
[Special scenarios] ignoreRedunantColumnsReplicate
[Foreign keys] disableForeignKeyCheck
[Error handling] maxRetryTimes
[Error handling] retryIntervalTime
[Debugging] dryRun
[SQL operations] updateSetAllColumns
[Error handling] skipErrorCode
[Error handling] skipErrorMessage
[Debugging] conflictPrintSize
[Tables without a primary key] enableNoUniqueConstraintTableReplicate
[Tables without a primary key] serialNoUniqueConstraintTable
[Transaction table] transactionTableClearTime
[Transaction table] transactionTableReserveDays
[Specific scenarios] serialExecuteTable
[Specific scenarios] useSSL
[Write query] dependTargetSchema
[Special scenarios] forceUpdateTimeField
[Write mode] writeMode

Starter class

Database type
Plug-in Jar
Booster class
MYSQL jdbc-sink-mysql.jar com.oceanbase.oms.connector.jdbc.sink.mysql.MySQLJDBCSinkBooster
DB2 jdbc-sink-db2.jar com.oceanbase.oms.connector.jdbc.sink.db2.DB2JDBCSinkBooster
OB_MYSQL jdbc-sink-ob-mysql.jar com.oceanbase.oms.connector.jdbc.sink.obmysql.OBMySQLJDBCSinkBooster
OB_ORACLE jdbc-sink-ob-oracle.jar com.oceanbase.oms.connector.jdbc.sink.oboracle.OBOracleJDBCSinkBooster
ORACLE jdbc-sink-oracle.jar com.oceanbase.oms.connector.jdbc.sink.oracle.OracleJDBCSinkBooster
POSTGRESQL jdbc-sink-pg.jar com.oceanbase.oms.connector.jdbc.sink.pg.PgJDBCSinkBooster
ADB jdbc-sink-adb.jar com.oceanbase.oms.connector.jdbc.sink.adb.ADBJDBCSinkBooster

[Cyclical replication prevention] txnTable

  • Description: specifies the transaction table that prevents cyclical replication and use.

  • Default value: drc_txn.

  • Value type: String.

  • Supported version: OceanBase Migration Service (OMS) Community Edition V3.3.1 and later.

[Cyclical replication prevention] txnDb

  • Description: specifies the database in which the transaction table that prevents cyclical replication and use is located.

  • Default value: test.

  • Value type: String.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Connection information] jdbcUrl

  • Description: specifies the connection string of the destination database.

  • Default value: None. This parameter is required.

  • Value type: String.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Connection information] username

  • Description: specifies the username for connecting to the destination database.

  • Default value: None. This parameter is required.

  • Value type: String.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Connection information] password

  • Description: specifies the password for connecting to the destination database.

  • Default value: None. This parameter is required.

  • Value type: String.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Debugging] printSql

  • Description: specifies whether to print the executed SQL statements.

  • Default value: false.

  • Value type: Boolean.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Threads] workerNum

  • Description: specifies the number of worker threads.

  • Default value: 16.

  • Value type: int.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Debugging] slowSqlThreshold

  • Description: specifies the threshold for determining slow SQL statements. It controls the executed SQL statements that are printed.

  • Default value: 15 ms.

  • Value type: int.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Connection information] timezone

  • Description: specifies the time zone.

  • Default value: UTC+8:00.

  • Valid values: time zones.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Filtering] notWriteColumn

  • Description: specifies the columns that do not need to be written.

  • Default value: None.

  • Value type: String.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Cyclical replication prevention] localRegionNo

  • Description: specifies the number of the region to which data is written.

  • Default value: None.

  • Value type: int.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Reverse anti-replay] transactionIdIsLong

  • Description: 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 reverse anti-replay and for compatibility with existing transaction tables.

  • Default value: false.

  • Value type: int.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Writing] useTargetIndex

  • Description: specifies whether to use indexes of the destination database for data synchronization

  • Default value: false.

  • Value type: Boolean.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Writing to partitions in OceanBase Database] sysUsername

  • Description: specifies the username of the sys tenant, which is in the three-segment format and used to write data into partitions in OceanBase Database.

  • Default value: None.

  • Value type: String.

  • Supported version: OMS Community Edition V4.0.0 and later.

[Writing to partitions in OceanBase Database] sysPassword

  • Description: specifies the password of the sys tenant, which is used to write data into partitions in OceanBase Database.

  • Default value: None.

  • Value type: String.

  • Supported version: OMS Community Edition V4.0.0 and later.

[Writing to partitions in OceanBase Database] sysInstance

  • Description: specifies the connection information of the sys tenant.

  • Default value: None.

  • Value type: String.

  • Supported version: OMS Community Edition V4.0.0 and later.

[Writing to partitions in OceanBase Database] tenant

  • Description: specifies the tenant to which data is written.

  • Default value: None.

  • Value type: String.

  • Supported version: OMS Community Edition V4.0.0 and later.

[Writing to partitions in OceanBase Database] enablePartitionBucket

  • Description: specifies whether to enable the feature of writing data to partitions.

  • Default value: false.

  • Value type: Boolean.

  • Supported version: OMS Community Edition V4.0.0 and later.

[Special scenarios] ignoreRedunantColumnsReplicate

  • Description: specifies whether to allow different quantities of fields in the source database and destination database.

  • Default value: false.

    During full migration or incremental synchronization between a MySQL database and OMS Community Edition, if an error table field in the source database does not exist in the destination database, you can set the ignoreRedunantColumnsReplicate parameter to true.

  • Value type: Boolean.

  • Supported version: OMS Community Edition V4.1.1 and later.

[Foreign keys] disableForeignKeyCheck

  • Description: specifies whether to disable the foreign key check.

  • Default value: true.

  • Value type: Boolean.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Error handling] maxRetryTimes

  • Description: specifies the maximum number of retries in the case of a destination writing failure.

  • Default value: 1000.

  • Value type: int.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Error handling] retryIntervalTime

  • Description: specifies the retry interval.

  • Default value: 3s.

  • Value type: int.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Debugging] dryRun

  • Description: specifies whether to enable dry-run without executing any SQL statements.

  • Default value: false.

  • Value type: Boolean.

  • Supported version: OMS Community Edition V3.3.1 and later.

[SQL operations] updateSetAllColumns

  • Description: specifies whether to apply the update operation to all columns.

  • Default value: false.

  • Value type: Boolean.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Error handling] skipErrorCode

  • Description: specifies the error codes to be ignored when data is written to the destination database. The value is a JSON array.

  • Default value: None.

  • Valid values: Error codes.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Error handling] skipErrorMessage

  • Description: specifies the error messages to be ignored when data is written to the destination database. The value is a JSON array.

  • Default value: None.

  • Valid values: Error content.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Debugging] conflictPrintSize

  • Description: specifies the maximum size of the single-key conflict queue that triggers printing.

  • Default value: 256.

  • Value type: int.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Tables without a primary key] enableNoUniqueConstraintTableReplicate

  • Description: specifies whether to migrate tables without a primary key during data migration from a MySQL database to a MySQL tenant of OceanBase Database, or from a MySQL tenant of OceanBase Database to a MySQL database.

  • Default value: false.

    For a data migration project not between a MySQL database and a MySQL tenant of OceanBase Database, this parameter will be automatically set to false even if you set it to true.

  • Value type: Boolean.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Tables without a primary key] serialNoUniqueConstraintTable

  • Description: specifies whether the transaction conflict matrix executes tables without a primary key in serial mode.

  • Default values:

  • Value type: Boolean.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Transaction table] transactionTableClearTime

  • Description: specifies the daily clearing time for transaction tables.

  • Default value: 02:00:00.

  • Valid values: Time.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Transaction table] transactionTableReserveDays

  • Description: specifies the retention period for transaction tables, in days.

  • Default value: 7.

  • Value type: int.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Specific scenarios] serialExecuteTable

  • Description: specifies the tables on which serial execution is performed. The tables are separated with commas (,).

  • Default value: Null.

  • Value type: String.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Specific scenarios] useSSL

  • Description: specifies whether to use SSL for linking.

  • Default value: false.

  • Value type: Boolean.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Write query] dependTargetSchema

  • Description: specifies whether to write data to the destination based on its schema.

  • Default value: true.

    If the value is false, the schema of the destination is not queried. When the destination is OceanBase Database, you may need to disable this parameter in some cases.

  • Value type: Boolean.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Special scenarios] forceUpdateTimeField

  • Description: specifies whether the update operation forcibly updates data of the time type.

  • Default value: true.

  • Value type: Boolean.

  • Supported version: OMS Community Edition V3.3.1 and later.

[Write mode] writeMode

  • Description: specifies the write mode of the destination.

  • Default value: batch.

  • Valid values: batch and noBatch.

  • Supported version: OMS Community Edition V3.2.2 and later.

Previous topic

Overview
Last

Next topic

KafkaSink
Next
on this page
Starter class
[Cyclical replication prevention] txnTable
[Cyclical replication prevention] txnDb
[Connection information] jdbcUrl
[Connection information] username
[Connection information] password
[Debugging] printSql
[Threads] workerNum
[Debugging] slowSqlThreshold
[Connection information] timezone
[Filtering] notWriteColumn
[Cyclical replication prevention] localRegionNo
[Reverse anti-replay] transactionIdIsLong
[Writing] useTargetIndex
[Writing to partitions in OceanBase Database] sysUsername
[Writing to partitions in OceanBase Database] sysPassword
[Writing to partitions in OceanBase Database] sysInstance
[Writing to partitions in OceanBase Database] tenant
[Writing to partitions in OceanBase Database] enablePartitionBucket
[Special scenarios] ignoreRedunantColumnsReplicate
[Foreign keys] disableForeignKeyCheck
[Error handling] maxRetryTimes
[Error handling] retryIntervalTime
[Debugging] dryRun
[SQL operations] updateSetAllColumns
[Error handling] skipErrorCode
[Error handling] skipErrorMessage
[Debugging] conflictPrintSize
[Tables without a primary key] enableNoUniqueConstraintTableReplicate
[Tables without a primary key] serialNoUniqueConstraintTable
[Transaction table] transactionTableClearTime
[Transaction table] transactionTableReserveDays
[Specific scenarios] serialExecuteTable
[Specific scenarios] useSSL
[Write query] dependTargetSchema
[Special scenarios] forceUpdateTimeField
[Write mode] writeMode