Data Transmission Service:Modify instance parameters

Prerequisites

A synchronization or migration instance has been created. For more information, see Synchronization Solution Overview or Migration Solution Overview.

Usage notes

• You can modify instance parameters only while the module is running. You can view the module's running status on the Task Management tab of the instance details page in the DTS console, under Progress.

• To ensure instance stability, you can modify only the parameters that are available on the Modifiable Parameters tab in the console. Parameters that are not displayed in the console cannot be modified.

• When you modify a parameter value, refer to the Valid Values, Parameter Type, and Description columns on the Modifiable Parameters tab.

• On the Modifiable Parameters tab in the console, after you submit modifications for parameters where the Force Restart column is set to Yes, DTS immediately restarts the module. Therefore, we recommend that you modify instance parameters during off-peak hours.

Select an instance

The steps to modify parameters are similar for data synchronization and data migration instances. This topic uses a data synchronization instance as an example.

1. Use one of the following methods to go to the Data Synchronization page and select the region in which the data synchronization instance resides.

   DTS console

   1. Log on to the DTS console.

   2. In the left-side navigation pane, click Data Synchronization.

   3. In the upper-left corner of the page, select the region in which the data synchronization task resides.

   DMS console

   Note

   The actual operations may vary based on the mode and layout of the DMS console. For more information, see Simple mode and Customize the layout and style of the DMS console.

   1. Log on to the DMS console.

   2. In the top navigation bar, move the pointer over Data + AI and choose DTS (DTS) > Data Synchronization.

   3. From the drop-down list to the right of Data Synchronization Tasks, select the region in which the data synchronization instance resides.

2. Find the destination instance.

   You can filter instances by task name, instance ID, or database instance ID to find the destination instance.

   

3. Click the ID of the destination instance.

Modify parameter values

1. Select the destination instance. For more information, see Select an instance.

2. Go to the parameter modification page.

   You can access the modification interface to make changes as needed.

   Note

   For a distributed instance, first click the Full Data Migration or Incremental Write module on the Task Management page. Then, click the corresponding subtask on the Subtask Details tab.

   • On the Parameter Settings page, you can modify the parameter values.

     In the navigation pane on the left, click Parameter Settings.

   • On the Task Management page, configure parameters.

     1. In the navigation pane on the left, click Task Management.

     2. In the Progress area, click the incremental synchronization or full synchronization module that contains the target parameter.

        Note

        You cannot modify parameters in the schema migration module.

     3. Below the module, click the Parameter Settings tab.

3. Modify the parameter value.

   1. Optional: Click the Modifiable Parameters tab.

   2. Click in the Parameter Value column for the target parameter.

   3. In the Modify Parameters dialog box, configure the parameters and click OK.

      Note

      The modifiable parameters may vary based on the DTS instance type, source and destination database types, and the synchronization or migration type selected during instance configuration. The parameters displayed in the console are the most up-to-date. The following table describes common parameters.

      Parameter Name	Module	Description
      source.connection.idle.second	Incremental synchronization Incremental migration	The timeout period for connecting to the source database. Unit: seconds. Valid values: [0, 86400]. Default value: 86400.
      sink.connection.idle.second	Incremental synchronization Incremental migration	The timeout period for connecting to the destination database. Unit: seconds. Valid values: [0, 86400]. Default value: 86400.
      sink.ignore.failed.ddl	Incremental synchronization Incremental migration	Specifies whether to ignore failed DDL operations. Valid values: true: The task ignores the failure and continues. This is the default value. false: The task fails if the DDL execution fails.
      sink.batch.enable	Incremental synchronization Incremental migration	Specifies whether to send data in batches. Valid values: true: Sends data in batches. false: Does not send data in batches. This is the default value.
      source.filter.ddl.enable	Incremental synchronization Incremental migration	Specifies whether to filter DDL operations. Valid values: true: The incremental task filters DDL operations and continues. false: The incremental task executes DDL operations as normal. This is the default value.
      trans.hot.merge.enable	Incremental synchronization Incremental migration	Specifies whether to enable hot spot merging. Valid values: true: Enables hot spot merging. false: Disables hot spot merging. This is the default value.
      sink.bulk.copy.enable	Full synchronization Full migration	Specifies whether to enable bulk copy mode when writing data to MySQL or PostgreSQL. Valid values: true: Enables bulk copy mode. This is the default value. false: Disables bulk copy mode. Note This parameter must be used with the sink.worker.type parameter.
      sink.worker.type	Full synchronization Full migration	Configures the data write mode for MySQL and PostgreSQL. Valid values: stream: Uses the bulk copy write mode. This is the default value. batch: Uses the PreparedStatement executeBatch write mode. In this case, sink.bulk.copy.enable must be set to false. Note This parameter must be used with the sink.bulk.copy.enable parameter.
      sink.batch.size.maximum	Full synchronization Full migration	The maximum number of rows that a write thread can write to the destination database in a single batch. Valid values: [0, 1024]. Default value: 1024.
      sink.batch.size.minimum	Full synchronization Full migration	The minimum number of rows that a write thread can write to the destination database in a single batch. Valid values: [0, 1024]. Default value: 128.
      source.mongodb.id.type.unique	Full synchronization Full migration	If the source database is MongoDB, specifies whether the data type of the primary key _id is unique within the same collection. Valid values: true: Unique. During the full task phase, DTS does not scan the data type of the primary key in the data to be synchronized or migrated. false: Not unique. This is the default value. During the full task phase, DTS scans the data type of the primary key in the data to be synchronized or migrated.

   4. Optional: Modify the values of other target parameters.

      Note

      Click Revoke. In the prompt box that appears, click OK to undo all uncommitted changes.

4. Click Apply Changes and then click OK in the pop-up dialog box.

   Note

   Currently, only the Take Effect Immediately option is supported, and it is selected by default.

View parameter modification history

1. Select the destination instance. For more information, see Select an instance.

2. In the navigation pane on the left, click Parameter Settings.

3. Click the Modification History tab.

4. Select the time range for the query.

   Note

   • By default, parameter modification records from the last seven days are displayed.

   • When you select a time range, the value on the left is the start time and the value on the right is the end time.

   • Only submitted parameter value modifications are recorded.