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