Modify instance parameters

Prerequisites

You must have a data synchronization or migration instance. For more information, see the configuration instructions in Synchronization scenarios or Migration scenarios.

Usage notes

• You can modify instance parameters only when the corresponding module is running. You can view the module status in the Progress section on the Task Management tab of the instance details page in the console.

• To ensure instance stability, you can modify only the parameters listed on the Modifiable Parameters tab.

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

• If the Force Restart column for a parameter is set to Yes on the Modifiable Parameters tab, DTS immediately restarts the module after you apply the change. We recommend modifying these parameters during off-peak hours to avoid service interruptions.

Select an instance

The procedure for modifying parameters is similar for data synchronization and data migration instances. This topic uses a data synchronization instance as an example.

1. Go to the data synchronization task list page in the destination region. You can do this in one of two ways.

   DTS console

   1. Log on to the DTS console.

   2. In the navigation pane on the left, click Data Synchronization.

   3. In the upper-left corner of the page, select the region where the synchronization instance is located.

   DMS console

   Note

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

   1. Log on to the DMS console.

   2. In the top menu bar, choose Data + AI > DTS (DTS) > Data Synchronization.

   3. To the right of Data Synchronization Tasks, select the region of the synchronization instance.

2. Find the target instance.

   To find the instance, filter by task name, instance ID, or database instance ID.

3. Click the ID of the target instance.

Modify parameter values

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

2. Go to the parameter modification page.

   You can choose one of the following methods:

   Note

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

   • Modify parameters on the Parameter Settings page.

     In the left-side navigation pane, click Parameter Settings.

   • Modify parameters on the Task Management page.

     1. In the left-side navigation pane, click Task Management.

     2. In the Progress section, click the full or incremental data synchronization module that contains the parameter you want to modify.

        Note

        You cannot modify parameters for the schema migration module.

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

3. Modify the parameter values.

   1. Optional: Click the Modifiable Parameters tab.

   2. For the parameter you want to modify, click the icon in the Parameter Value column.

   3. In the Modify Parameters dialog box, change the parameter value, and click OK.

      Note

      The modifiable parameters may vary depending on factors such as the DTS instance type, the source and destination database instance types, and the synchronization or migration type you select during configuration. The parameters displayed in the console are definitive. The following table describes some common parameters.

      Parameter	Module	Description
      source.connection.idle.second	incremental data synchronization incremental data migration	The timeout period for an idle connection to the source database, in seconds. Valid values: [0, 86400]. Default value: 86400.
      sink.connection.idle.second	incremental data synchronization incremental data migration	The timeout period for an idle connection to the destination database, in seconds. Valid values: [0, 86400]. Default value: 86400.
      sink.ignore.failed.ddl	incremental data synchronization incremental data migration	Specifies whether to ignore failed DDL operations. Valid values: true (default): If a DDL operation fails, the task ignores the failure and continues. false: If a DDL operation fails, the task fails.
      sink.batch.enable	incremental data synchronization incremental data migration	Specifies whether to send data by using batch commit. Valid values: true: Sends data by using batch commit. false (default): Does not send data by using batch commit.
      source.filter.ddl.enable	incremental data synchronization incremental data migration	Specifies whether to filter DDL operations. Valid values: true: The incremental task filters DDL operations and continues. false (default): The incremental task executes DDL operations normally.
      trans.hot.merge.enable	incremental data synchronization incremental data migration	Specifies whether to enable hot data merging. Valid values: true: Enables hot data merging. false (default): Disables hot data merging.
      sink.bulk.copy.enable	full data synchronization full data migration	Specifies whether to enable bulk copy mode when writing data to MySQL or PostgreSQL. Valid values: true (default): Enables bulk copy mode. false: Disables bulk copy mode. Note This parameter must be used with the sink.worker.type parameter.
      sink.worker.type	full data synchronization full data migration	Specifies the data write mode for MySQL and PostgreSQL. Valid values: stream (default): Uses the bulk copy write mode. 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 data synchronization full data 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 data synchronization full data 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 data synchronization full data migration	When the source is a MongoDB database, specifies whether the data type of the _id primary key is consistent across all documents in a collection. Valid values: true: Unique. During the full data task, DTS does not scan the data types of the primary key in the data to be synchronized or migrated from the source database. false (default): Not unique. During the full data task, DTS scans the data types of the primary key in the data to be synchronized or migrated from the source database.

   4. Optional: Modify other parameters as needed.

      Note

      Click Revoke and then click OK in the confirmation dialog box to undo all unsubmitted changes.

4. Click Apply Changes, and then click OK in the confirmation dialog box.

   Note

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

Parameter modification history

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

2. In the left-side navigation pane, click Parameter Settings.

3. Click the Modification History tab.

4. Select a time range.

   Note

   • By default, the console displays parameter modification records from the last seven days.

   • Specify a start and end time for the query.

   • Only applied changes are recorded.