JDBC-Sink

Starter class

[Cyclical replication prevention] txnTable

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

• Default value: drc_txn.

• Valid values: strings.

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

[Cyclical replication prevention] txnDb

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

• Default value: test.

• Valid values: strings.

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

[Connection information] jdbcUrl

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

• Default value: None. This parameter is required.

• Valid values: strings.

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

[Connection information] username

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

• Default value: None. This parameter is required.

• Valid values: strings.

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

[Connection information] password

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

• Default value: None. This parameter is required.

• Valid values: strings.

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

[Debugging] printSql

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

• Default value: false.

• Valid values: Boolean values.

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

• [Threads] workerNum

• Description: specifies the number of worker threads.

• Default value: 16.

• Valid values: integer values.

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

[Debugging] slowSqlThreshold

• Description: specifies the threshold for identifying slow SQL statements. It controls the executed SQL statements to be printed.

• Default value: 15ms.

• Valid values: integer values.

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

[Connection information] timezone

• Description: specifies the time zone.

• Default value: +08:00.

• Valid values: time zones.

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

[Filtering] notWriteColumn

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

• Default value: None.

• Valid values: strings.

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

[Cyclical replication prevention] localRegionNo

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

• Default value: None.

• Valid values: integer values.

• Supported versions: 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.

• Valid values: integer values.

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

[Writing] useTargetIndex

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

• Default value: false.

• Valid values: Boolean values.

• Supported versions: 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.

• Valid values: strings.

• Supported versions: 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.

• Valid values: strings.

• Supported versions: 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.

• Valid values: strings.

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

[Writing to partitions in OceanBase Database] tenant

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

• Default value: None.

• Valid values: strings.

• Supported versions: 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.

• Valid values: Boolean values.

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

[Special scenarios] ignoreRedunantColumnsReplicate

• Description: specifies whether to allow data migration between tables that have different numbers of fields.

• Default value: false.

  If an error is reported because a field of the source table does not exist in the target table during full migration or incremental synchronization between a MySQL database and OMS Community Edition, you can set the ignoreRedunantColumnsReplicate parameter to true and then resume the data migration task.

• Valid values: Boolean values.

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

[Foreign keys] disableForeignKeyCheck

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

• Default value: true.

• Valid values: Boolean values.

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

[Error handling] maxRetryTimes

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

• Default value: 1000.

• Valid values: integer values.

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

[Error handling] retryIntervalTime

• Description: specifies the retry interval.

• Default value: 3s.

• Valid values: integer values.

• Supported versions: 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.

• Valid values: Boolean values.

• Supported versions: 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.

• Valid values: Boolean values.

• Supported versions: 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 target database. The value must be a JSON array.

• Default value: None.

• Valid values: error codes.

• Supported versions: 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 target database. The value must be a JSON array.

• Default value: None.

• Valid values: error messages.

• Supported versions: 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.

• Valid values: integer values.

• Supported versions: 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-compatible tenant of OceanBase Database, or from a MySQL-compatible tenant of OceanBase Database to a MySQL database.

• Default value: false.

  For a task that does not migrate data between a MySQL database and a MySQL-compatible tenant of OceanBase Database, this parameter will be automatically set to false even if you set it to true.

• Valid values: Boolean values.

• Supported versions: OMS Community Edition V4.0.0 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 value:

• Valid values: Boolean values.

• Supported versions: 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 versions: OMS Community Edition V3.3.1 and later.

[Transaction table] transactionTableReserveDays

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

• Default value: 7.

• Valid values: integer values.

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

[Specific scenarios] serialExecuteTable

• Description: specifies the tables on which serial execution is to be performed. Separate multiple tables with commas (,).

• Default value: Null.

• Valid values: strings.

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

[Specific scenarios] useSSL

• Description: specifies whether to use SSL for linking.

• Default value: false.

• Valid values: Boolean values.

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

[Write query] dependTargetSchema

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

• Default value: true.

  If the value is false, the schema of the target is not queried. If the target is OceanBase Database, you need to disable this parameter in some cases. For example, when you migrate a large amount of table data from OceanBase Database V3.x to OceanBase Database V4.x, you will fail to create a data migration task because many queries must be executed on each table.

  Note

  When `dependTargetSchema` is set to `false`, a difference between the schemas of the source and target tables may result in data consistency. For example, if the primary key of the source table is different from that of the target table, data issues may occur.

• Valid values: Boolean values.

• Supported versions: 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.

• Valid values: Boolean values.

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

[Write mode] writeMode

• Description: specifies the write mode of the target.

• Default value: batch.

• Valid values: batch and noBatch.

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

datasource.variables

OceanBase Database Community Edition supports session-level variables datasource.variables.xxx. xxx specifies the configuration of the session-level variable to be executed.

For example, datasource.variables._FORCE_PARALLEL_DDL_DOP specifies the degree of parallelism (DOP). You can set a DOP value as needed. For more information about _FORCE_PARALLEL_DDL_DOP, see Classification and optimization of parallel execution.

loadSysmetaFromCache

• Description: specifies whether to cache system views.

• Default value: true.

  • true: specifies to load system views from the local cache.

    Notice

    The value true of loadSysmetaFromCache takes effect only if you have clicked Cache System View on the Data Source Management page in the console of OMS Community Edition and the O&M task has been successfully executed.

  • false: specifies to directly load system views from the database.

• Valid values: Boolean values.

• Supported versions: OMS Community Edition V4.2.5 and later.

insertMode

• Description: specifies the syntax used to write data.

• Default value: INSERT.

• Valid values:

  • INSERT: specifies to use the INSERT INTO syntax to write data.

  • REPLACE: specifies to use the REPLACE INTO syntax to write data.

  • INSERT_IGNORE: specifies to use the INSERT IGNORE INTO syntax to write data.

• Supported versions: OMS Community Edition V4.2.7 and later.

geomExchangeLonLat

• Description: specifies whether to switch the sequences of the longitude and latitude.

  This parameter is valid only when the target is a MySQL database and the source is a MySQL-compatible tenant of OceanBase Database.

• Default value: true.

• Valid values: Boolean values.

• Supported versions: OMS Community Edition V4.2.7 and later.

postgisGeometryBinaryConvert

• Description: specifies whether to convert the incremental data of PostGIS.

  This parameter is valid only when the target is a MySQL-compatible tenant of OceanBase Database and the source is a PostgreSQL database.

• Default value: true.

• Valid values: Boolean values.

• Supported versions: OMS Community Edition V4.2.7 and later.