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. |
| rowidExtendedColumns | No | OMS_OBJECT_NUMBER,OMS_RELATIVE_FNO,OMS_BLOCK_NUMBER,OMS_ROW_NUMBER | The names of the four columns into which the Oracle ROWID column 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 | By default, comments in DDL statements are filtered only when the source database is DB2. | Specifies whether to filter comments in DDL statements. |
| db2Mode | No | normal | The mode of DB2. Valid values: oracle and normal. |
| 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 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, oracle, oceanbase, oceanbase1, db2, and oceanbase_oracle_mode. oceanbase represents OB05, oceanbase1 represents a MySQL tenant in OceanBase Database, and oceanbase_oracle_mode represents an Oracle tenant in 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. Set this parameter to true only when data is reversely synchronized from an Oracle tenant in OceanBase Database to an Oracle database. |
| tx_records_limit | No | 128 | 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.
|
| 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 Oracle database, a DB2 database, an OB05 database, or Oceanbase Database in Oracle mode, and filter.table under the migration user applies. |
| filter.table | No | drc_txn | The transaction table that prevents cyclical replication and use. filter.db is invalid when data is written to an Oracle database, a DB2 database, an OB05 database, or Oceanbase Database in Oracle mode, and filter.table under the migration user applies. |
| 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. |