Data Transmission Service:Reserve parameter

• 0: performs a precheck and reports errors.
• 2: ignores errors and proceeds.

• overwrite: If a data conflict occurs during data synchronization, the conflicting data in the destination database is overwritten.
• interrupt: If a data conflict occurs during data synchronization, an error is reported and the data synchronization task fails. You must manually modify and resume the data synchronization task.
• ignore: If a data conflict occurs during data synchronization, the conflicting data in the destination database is retained and the data synchronization task continues.

• true: does not synchronize DDL operations.
• false: synchronizes DDL operations.
  Important By default, the reverse task ignores DDL operations.

• none (default): does not start a precheck or subsequent operations after the DTS task is configured. In this case, you must manually start the DTS task.
• auto: automatically starts a precheck and all subsequent operations after the DTS task is configured.

• Y
• N

• oneway: one-way synchronization.
• bidirectional: two-way synchronization.

• default: uses the default capitalization policy of DTS.
• source: uses the capitalization policy of the source database.
• dest_upper: uses the uppercase.
• dest_lower: uses the lowercase.

{
     "srcInstanceId": "cen-9kqshqum*******"  }

{
     "destInstanceId": "cen-9kqshqum*******"  }

• true
• false (default)

• none: does not write SQL operations on heartbeat tables to the source database.
• N: writes SQL operations on heartbeat tables to the source database.

• Copy the temporary tables that are generated by online DDL operations performed on source tables to the destination database.

  {
       "whitelist.dms.online.ddl.enable": "true",
       "sqlparser.dms.original.ddl": "false",
       "whitelist.ghost.online.ddl.enable": "true",
       "sqlparser.ghost.original.ddl": "false"
  }

• Do not copy the temporary tables that are generated by online DDL operations performed on source tables to the destination database, but synchronize only the original DDL operations that are performed by using Data Management (DMS) in the source database.

  {
       "whitelist.dms.online.ddl.enable": "false",
       "sqlparser.dms.original.ddl": "true",
       "whitelist.ghost.online.ddl.enable": "false",
       "sqlparser.ghost.original.ddl": "false"
  }

• Do not copy the temporary tables that are generated by online DDL operations performed on source tables to the destination database, but synchronize only the original DDL operations that are performed by using gh-ost in the source database.

  {
       "whitelist.dms.online.ddl.enable": "false",
       "sqlparser.dms.original.ddl": "false",
       "whitelist.ghost.online.ddl.enable": "false",
       "sqlparser.ghost.original.ddl": "true",
       "online.ddl.shadow.table.rule": "^_(.+)_(?:gho|new)$",
       "online.ddl.trash.table.rule": "^_(.+)_(?:ghc|del|old)$"
  }

  Note You can specify the default or custom regular expressions for online.ddl.shadow.table.rule and online.ddl.trash.table.rule to filter out the shadow tables of the gh-ost tool and tables that are not required.

• 0: does not encrypt the connection.
• 1: encrypts the connection by using SSL.

• none: does not write SQL operations on heartbeat tables to the source database.
• N: writes SQL operations on heartbeat tables to the source database.

• Copy the temporary tables that are generated by online DDL operations performed on source tables to the destination database.

  {
       "whitelist.dms.online.ddl.enable": "true",
       "sqlparser.dms.original.ddl": "false",
       "whitelist.ghost.online.ddl.enable": "true",
       "sqlparser.ghost.original.ddl": "false"
  }

• Do not copy the temporary tables that are generated by online DDL operations performed on source tables to the destination database, but synchronize only the original DDL operations that are performed by using DMS in the source database.

  {
       "whitelist.dms.online.ddl.enable": "false",
       "sqlparser.dms.original.ddl": "true",
       "whitelist.ghost.online.ddl.enable": "false",
       "sqlparser.ghost.original.ddl": "false"
  }

• Do not copy the temporary tables that are generated by online DDL operations performed on source tables to the destination database, but synchronize only the original DDL operations that are performed by using gh-ost in the source database.

  {
       "whitelist.dms.online.ddl.enable": "false",
       "sqlparser.dms.original.ddl": "false",
       "whitelist.ghost.online.ddl.enable": "false",
       "sqlparser.ghost.original.ddl": "true",
       "online.ddl.shadow.table.rule": "^_(.+)_(?:gho|new)$",
       "online.ddl.trash.table.rule": "^_(.+)_(?:ghc|del|old)$"
  }

  Note You can specify the default or custom regular expressions for online.ddl.shadow.table.rule and online.ddl.trash.table.rule to filter out the shadow tables of the gh-ost tool and tables that are not required.

• 0: does not encrypt the connection.
• 1: encrypts the connection by using SSL.

• sid: non-Real Application Cluster (RAC).
• serviceName: RAC or pluggable database (PDB).

• default (default)
• GB 2312
• GBK
• GB 18030
• UTF-8
• UTF-16
• UTF-32

• cdc: performs incremental data synchronization or migration by parsing the logs of the source database for non-heap tables, and performs change data capture (CDC)-based incremental data synchronization or migration for heap tables.
• log: performs incremental data synchronization or migration by parsing the logs of the source database.

• schema.table: uses Source schema name.Source table name as the name of the destination table.
• without.schema: uses the source table name as the name of the destination table.
  Warning If multiple schemas in the source database contain tables that have the same name, data inconsistency may occur or the DTS task may fail.

• single: standalone deployment.
• cluster: cluster deployment.

EXPIRE key seconds
PEXPIRE key milliseconds
EXPIREAT key timestamp
PEXPIREAT key timestampMs

• true: pulls data from replica nodes.
• false (default): pulls data from master nodes.

• 0: standalone architecture.
• 1: replica set architecture.
• 2: sharded cluster architecture.

• none: does not write SQL operations on heartbeat tables to the source database.
• N: writes SQL operations on heartbeat tables to the source database.

• single
• multiple

• none: does not write SQL operations on heartbeat tables to the source database.
• N: writes SQL operations on heartbeat tables to the source database.

• EXPRESS: connected over Express Connect, VPN Gateway, or Smart Access Gateway.
• ECS: self-managed cluster hosted on an ECS instance.

• The ID of the ECS instance if the value of taskType is set to ECS.
• The ID of the VPC that is connected to the source database if the value of taskType is set to EXPRESS.

• 0: does not encrypt the connection.
• 3: encrypts the connection by using the SCRAM-SHA-256 algorithm.

• manual
• auto

• 0: does not encrypt the connection.
• 1: encrypts the connection by using SSL.

• innodb: the default storage engine.
• xengine: the database storage engine for online transaction processing (OLTP).

• manual
• auto

• manual
• auto

• tagColumnValue: customizes the tag column.
  Important If you set this parameter to tagColumnValue, you must specify the value of the custom tag column in the DbList parameter. For more information, see Objects of DTS tasks.
• notTagColumnValue: does not customize the tag column.
  Important The tag column can be customized only for DTS instances that are configured after purchase.

• insert
• update
• delete
• alterTable
• truncateTable
• createTable
• dropTable

• insert
• update
• delete
• alterTable
• truncateTable
• createTable
• dropTable
• createDB
• dropDB

• manual
• auto

• 0: does not encrypt the connection.
• 1: encrypts the connection by using SSL.

• 0: standalone architecture.
• 1: replica set architecture.
• 2: sharded cluster architecture.

• single: standalone deployment.
• cluster: cluster deployment.

EXPIRE key seconds
PEXPIRE key milliseconds
EXPIREAT key timestamp
PEXPIREAT key timestampMs

• single
• multiple

• sid: non-RAC.
• serviceName: RAC or PDB.

• true: uses the new naming rules.
• false: uses the original naming rules.

• true: uses the new naming rules.
• false: uses the original naming rules.

• Valid values if isUseNewAttachedColumn is set to true:
  • modifytime_year
  • modifytime_month
  • modifytime_day
  • modifytime_hour
  • modifytime_minute
• Valid values if isUseNewAttachedColumn is set to false:
  • new_dts_sync_modifytime_year
  • new_dts_sync_modifytime_month
  • new_dts_sync_modifytime_day
  • new_dts_sync_modifytime_hour
  • new_dts_sync_modifytime_minute

• tb: The name of the index to be created is the same as that of the table.
• db_tb: The name of the index to be created consists of the database name, an underscore (_), and the table name in sequence.

• 0: does not encrypt the connection.
• 3: encrypts the connection by using the SCRAM-SHA-256 algorithm.

• canal_json: DTS uses Canal to parse the incremental logs of the source database and transfer the incremental data to the destination Kafka cluster in the Canal JSON format.
• dts_avro: DTS uses the Avro format to transfer data. Avro is a data serialization format into which data structures or objects can be converted to facilitate storage and transmission.
• shareplex_json: DTS uses the data replication software SharePlex to read the data in the source database and write the data to the destination Kafka cluster in the SharePlex JSON format.
• debezium: DTS uses Debezium to transfer data. Debezium is a tool for capturing data changes. It streams data updates from the source database to the destination Kafka cluster in real time.

• none: DTS synchronizes all data and DDL statements to Partition 0 of the destination topic.
• database_table: DTS uses the database and table names as the partition key to calculate the hash value. Then, DTS synchronizes the data and DDL statements of each table to the corresponding partition of the destination topic.
• columns: DTS uses a table column as the partition key to calculate the hash value. By default, the primary key is used as the partition key. If a table does not have a primary key, the unique key is used as the partition key. DTS synchronizes each row to the corresponding partition of the destination topic. You can specify one or more columns as partition keys to calculate the hash value.