All Products
Search
Document Center

Data Transmission Service:Configure a data synchronization task by using the new DTS console

Last Updated:Oct 15, 2024

Data Transmission Service (DTS) provides an easy-to-use data synchronization feature. To configure a data synchronization task, you need to only perform simple operations in the new DTS console.

Usage notes

This topic provides a general procedure for configuring a data synchronization task. The procedure varies based on the source and destination databases. For more information, see Overview of data synchronization scenarios.

Note

This topic describes how to configure a task for one-way data synchronization between ApsaraDB RDS for MySQL instances before a data synchronization instance is purchased. The parameter configurations in this topic are for reference only. The parameters that are required when you configure a data synchronization task are displayed in the DTS console.

Prerequisites

  • If the source or destination database is a self-managed database, you must prepare the environments that are required by DTS. For more information, see Preparation overview.

  • The source and destination databases are created and the database versions are supported by DTS. For more information about the supported database types and versions, see Overview of data synchronization scenarios.

Procedure

  1. Go to the Data Synchronization Tasks page.

    1. Log on to the Data Management (DMS) console.

    2. In the top navigation bar, click DTS.

    3. In the left-side navigation pane, choose DTS (DTS) > Data Synchronization.

    Note
  2. On the right side of Data Synchronization Tasks, select the region in which the data synchronization instance resides.

    Note

    If you use the new DTS console, you must select the region in which the data synchronization instance resides in the top navigation bar.

  3. Click Create Task to go to the task configuration page.

  4. Optional. In the upper-right corner of the page, click New Configuration Page.

    Note
    • Skip this step if the Back to Previous Version button is displayed in the upper-right corner of the page.

    • Specific parameters in the new and previous versions of the configuration page may be different. We recommend that you use the new version of the configuration page.

  5. Configure the source and destination databases. The following table describes the parameters.

    Warning

    After you configure the source and destination databases, we recommend that you read the Limits that are displayed on the page. Otherwise, the task may fail or data inconsistency may occur.

    Section

    Parameter

    Description

    N/A

    Task Name

    The name of the DTS task. DTS automatically generates a task name. We recommend that you specify a descriptive name that makes it easy to identify the task. You do not need to specify a unique task name.

    Source Database

    Select a DMS database instance.

    In this example, no database instance is selected. Configure the following database information.

    Database Type

    The type of the source database. Select MySQL.

    Access Method

    The access method of the source database. Select Alibaba Cloud Instance.

    Instance Region

    The region in which the source ApsaraDB RDS for MySQL instance resides.

    Replicate Data Across Alibaba Cloud Accounts

    In this example, a database instance of the current Alibaba Cloud account is used. Select No.

    RDS Instance ID

    The ID of the source ApsaraDB RDS for MySQL instance.

    Database Account

    The database account of the source ApsaraDB RDS for MySQL instance. The account must have the SELECT permission on the objects to be synchronized, the REPLICATION CLIENT permission, and the REPLICATION SLAVE permission.

    Database Password

    The password that is used to access the database instance.

    Encryption

    In this example, you can use the default setting.

    Destination Database

    Select a DMS database instance.

    In this example, no database instance is selected. Configure the following database information.

    Database Type

    The type of the destination database. Select MySQL.

    Access Method

    The access method of the destination database. Select Alibaba Cloud Instance.

    Instance Region

    The region in which the destination ApsaraDB RDS for MySQL instance resides.

    Replicate Data Across Alibaba Cloud Accounts

    In this example, a database instance of the current Alibaba Cloud account is used. Select No.

    RDS Instance ID

    The ID of the destination ApsaraDB RDS for MySQL instance.

    Database Account

    The database account of the destination ApsaraDB RDS for MySQL instance. The account must have the read and write permissions.

    Database Password

    The password that is used to access the database instance.

    Encryption

    In this example, you can use the default setting.

  6. In the lower part of the page, click Test Connectivity and Proceed.

    If the source or destination database is an Alibaba Cloud database instance, such as an ApsaraDB RDS for MySQL or ApsaraDB for MongoDB instance, DTS automatically adds the CIDR blocks of DTS servers to the whitelist of the instance. If the source or destination database is a self-managed database hosted on an Elastic Compute Service (ECS) instance, DTS automatically adds the CIDR blocks of DTS servers to the security group rules of the ECS instance, and you must make sure that the ECS instance can access the database. If the database is deployed on multiple ECS instances, you must manually add the CIDR blocks of DTS servers to the security group rules of each ECS instance. If the source or destination database is a self-managed database that is deployed in a data center or provided by a third-party cloud service provider, you must manually add the CIDR blocks of DTS servers to the whitelist of the database to allow DTS to access the database. For more information, see the CIDR blocks of DTS servers section of the Add the CIDR blocks of DTS servers topic.

    Warning

    If the CIDR blocks of DTS servers are automatically or manually added to the whitelist of the database or instance, or to the ECS security group rules, security risks may arise. Therefore, before you use DTS to synchronize data, you must understand and acknowledge the potential risks and take preventive measures, including but not limited to the following measures: enhancing the security of your username and password, limiting the ports that are exposed, authenticating API calls, regularly checking the whitelist or ECS security group rules and forbidding unauthorized CIDR blocks, or connecting the database to DTS by using Express Connect, VPN Gateway, or Smart Access Gateway.

  7. Configure the objects to be synchronized.

    1. On the Select Objects page, configure the objects that you want to synchronize.

      In this example, make sure that Schema Synchronization, Full Data Synchronization, and Incremental Data Synchronization are selected for Synchronization Types, and the objects to be synchronized are selected from the Source Objects section. Retain the default settings for other parameters. You can also configure the parameters based on your business requirements.

      Configuration description

      Parameter

      Description

      Synchronization Types

      The synchronization types. By default, Incremental Data Synchronization is selected. You must also select Schema Synchronization and Full Data Synchronization. After the precheck is complete, DTS synchronizes the historical data of the selected objects from the source database to the destination cluster. The historical data is the basis for subsequent incremental synchronization.

      Method to Migrate Triggers in Source Database

      The method used to synchronize triggers from the source database. You can select a synchronization method based on your business requirements. If no triggers are to be synchronized, you do not need to configure this parameter. For more information, see Synchronize or migrate triggers from the source database.

      Note

      This parameter is available only if Schema Synchronization is selected for Synchronization Types.

      Enable Migration Assessment

      Specifies whether to enable synchronization assessment. Synchronization assessment aims to check whether the schemas of the source and destination databases, such as the length of indexes, stored procedures, and dependent tables, meet the requirements. Select Yes or No based on your business requirements.

      Note
      • This parameter is available only if Schema Synchronization is selected for Synchronization Types.

      • If you select Yes, the precheck may take more time. You can view Assessment Result during the precheck. The assessment results do not affect the precheck results.

      Synchronization Topology

      The synchronization topology of the data synchronization task. Select One-way Synchronization.

      Processing Mode of Conflicting Tables

      • Precheck and Report Errors: checks whether the destination database contains tables that have the same names as tables in the source database. If the source and destination databases do not contain tables that have identical table names, the precheck is passed. Otherwise, an error is returned during the precheck, and the data synchronization task cannot be started.

        Note

        If the source and destination databases contain tables with identical names and the tables in the destination database cannot be deleted or renamed, you can use the object name mapping feature to rename the tables that are synchronized to the destination database. For more information, see Map object names.

      • Ignore Errors and Proceed: skips the precheck for identical table names in the source and destination databases.

        Warning

        If you select Ignore Errors and Proceed, data inconsistency may occur and your business may be exposed to potential risks.

        • If the source and destination databases have the same schema and a data record in the destination database has the same primary key value or unique key value as a data record in the source database:

          • During full data synchronization, DTS does not synchronize the data record to the destination database. The existing data record in the destination database is retained.

          • During incremental data synchronization, DTS synchronizes the data record to the destination database. The existing data record in the destination database is overwritten.

        • If the source and destination databases have different schemas, data may fail to be initialized. In this case, only some columns are synchronized, or the data synchronization task fails. Proceed with caution.

      Capitalization of Object Names in Destination Instance

      The capitalization of database names, table names, and column names in the destination instance. By default, DTS default policy is selected. You can select other options to ensure that the capitalization of object names is consistent with that in the source or destination database. For more information, see Specify the capitalization of object names in the destination instance.

      Source Objects

      Select one or more objects from the Source Objects section and click the 向右 icon to add the objects to the Selected Objects section.

      Note

      You can select columns, tables, or databases as objects to synchronize. If you select tables or columns as the objects to be synchronized, DTS does not synchronize other objects such as views, triggers, and stored procedures to the destination database.

      Selected Objects

      • To rename an object that you want to synchronize to the destination instance, right-click the object in the Selected Objects section. For more information, see the Map the name of a single object section of the Map object names topic.

      • To rename multiple objects at a time, click Batch Edit in the upper-right corner of the Selected Objects section. For more information, see the Map multiple object names at a time section of the Map object names topic.

      Note
      • To select SQL operations performed on a specific database or table, right-click an object in the Selected Objects section. In the dialog box that appears, select the SQL operations that you want to synchronize.

      • To specify WHERE conditions to filter data, right-click a table in the Selected Objects section. In the dialog box that appears, specify the conditions. For more information, see Set filter conditions.

    2. Click Next: Advanced Settings to configure advanced settings.

      In this example, you can use the default settings or configure the parameters based on your business requirements.

      Configuration description

      Parameter

      Description

      Dedicated Cluster for Task Scheduling

      By default, DTS schedules tasks to shared clusters. You do not need to configure this parameter. If you want to improve the stability of data synchronization tasks, purchase a dedicated cluster. For more information, see What is a DTS dedicated cluster.

      Copy the temporary table of the Online DDL tool that is generated in the source table to the destination database.

      If you use DMS or the gh-ost tool to perform online DDL operations on the source database, you can specify whether to synchronize the data of temporary tables generated by online DDL operations.

      Important

      You cannot use tools such as pt-online-schema-change to perform online DDL operations on the source database. Otherwise, the DTS task fails.

      • Yes: DTS synchronizes the data of temporary tables generated by online DDL operations.

        Note

        If online DDL operations generate a large amount of data, the data synchronization task may take an extended period of time to complete.

      • No, Adapt to DMS Online DDL: DTS does not synchronize the data of temporary tables generated by online DDL operations. Only the original DDL operations that are performed by using DMS are synchronized.

        Note

        If you select this option, the tables in the destination database may be locked.

      • No, Adapt to gh-ost: DTS does not synchronize the data of temporary tables generated by online DDL operations. Only the original DDL operations that are performed by using the gh-ost tool are synchronized. You can use the default or custom regular expressions to filter out the shadow tables of the gh-ost tool and tables that are not required.

        Note

        If you select this option, the tables in the destination database may be locked.

      Whether to Migrate Accounts

      Specifies whether to synchronize the account information of the source database. You can configure this parameter based on your business requirements. If you select Yes, you must select the accounts to be synchronized and check their permissions. For more information such as authorization methods, see Migrate database accounts.

      Retry Time for Failed Connections

      The retry time range for failed connections. If the source or destination database fails to be connected after the data synchronization task is started, DTS immediately retries a connection within the time range. Valid values: 10 to 1440. Unit: minutes. Default value: 720. We recommend that you set this parameter to a value greater than 30. If DTS reconnects to the source and destination databases within the specified time range, DTS resumes the data synchronization task. Otherwise, the data synchronization task fails.

      Note
      • If you specify different retry time ranges for multiple data synchronization tasks that have the same source or destination database, the shortest retry time range takes precedence.

      • When DTS retries a connection, you are charged for the DTS instance. We recommend that you specify the retry time range based on your business requirements. You can also release the DTS instance at your earliest opportunity after the source and destination instances are released.

      Retry Time for Other Issues

      The retry time range for other issues. For example, if the DDL or DML operations fail to be performed after the data synchronization task is started, DTS immediately retries the operations within the time range. Valid values: 1 to 1440. Unit: minutes. Default value: 10. We recommend that you set this parameter to a value greater than 10. If the failed operations are successfully performed within the specified time range, DTS resumes the data synchronization task. Otherwise, the data synchronization task fails.

      Important

      The value of the Retry Time for Other Issues parameter must be smaller than the value of the Retry Time for Failed Connections parameter.

      Enable Throttling for Full Data Migration

      During full data synchronization, DTS uses the read and write resources of the source and destination databases. This may increase the load on the database servers. You can configure the Queries per second (QPS) to the source database, RPS of Full Data Migration, and Data migration speed for full migration (MB/s) parameters for full data synchronization tasks to reduce the load on the destination database server.

      Note

      This parameter is displayed only if Full Data Synchronization is selected for the Synchronization Types parameter.

      Enable Throttling for Incremental Data Synchronization

      Specifies whether to enable throttling for incremental data synchronization. You can enable throttling for incremental data synchronization based on your business requirements. To configure throttling, you must configure the RPS of Incremental Data Synchronization and Data synchronization speed for incremental synchronization (MB/s) parameters. This reduces the load on the destination database server.

      Environment Tag

      The environment tag that is used to identify the DTS instance. You can select an environment tag based on your business requirements.

      Whether to delete SQL operations on heartbeat tables of forward and reverse tasks

      Specifies whether to write SQL operations on heartbeat tables to the source database while the DTS instance is running. Valid values:

      • Yes: does not write SQL operations on heartbeat tables. In this case, a latency of the DTS instance may be displayed.

      • No: writes SQL operations on heartbeat tables. In this case, features such as physical backup and cloning of the source database may be affected.

      Configure ETL

      Specifies whether to enable the extract, transform, and load (ETL) feature. For more information, see What is ETL? Valid values:

      Monitoring and Alerting

      Specifies whether to configure alerting for the data synchronization task. If the task fails or the synchronization latency exceeds the specified threshold, alert contacts will receive notifications. Valid values:

    3. Click Next Step: Data Verification to configure data verification.

      For more information about how to use the data verification feature, see Configure a data verification task.

  8. Save the task settings and run a precheck.

    • To view the parameters to be specified when you call the relevant API operation to configure the DTS task, move the pointer over Next: Save Task Settings and Precheck and click Preview OpenAPI parameters.

    • If you do not need to view or have viewed the parameters, click Next: Save Task Settings and Precheck in the lower part of the page.

    Note
    • Before you can start the data synchronization task, DTS performs a precheck. You can start the data synchronization task only after the task passes the precheck.

    • If the data synchronization task fails the precheck, click View Details next to each failed item. After you analyze the causes based on the check results, troubleshoot the issues. Then, rerun the precheck.

    • If an alert is triggered for an item during the precheck:

      • If an alert item cannot be ignored, click View Details next to the failed item and troubleshoot the issue. Then, run a precheck again.

      • If an alert item can be ignored, click Confirm Alert Details. In the View Details dialog box, click Ignore. In the message that appears, click OK. Then, click Precheck Again to run a precheck again. If you ignore the alert item, data inconsistency may occur, and your business may be exposed to potential risks.

  9. Wait until the Success Rate becomes 100%. Then, click Next: Purchase Instance.

  10. Purchase a data synchronization instance.

    1. On the buy page, configure the Billing Method and Instance Class parameters for the data synchronization instance. The following table describes the parameters.

      Section

      Parameter

      Description

      New Instance Class

      Billing Method

      • Subscription: You pay for a subscription when you create a data synchronization instance. The subscription billing method is more cost-effective than the pay-as-you-go billing method for long-term use.

      • Pay-as-you-go: A pay-as-you-go instance is billed on an hourly basis. The pay-as-you-go billing method is suitable for short-term use. If you no longer require a pay-as-you-go data synchronization instance, you can release the instance to reduce costs.

      Resource Group Settings

      The resource group to which the data synchronization instance belongs. Default value: default resource group. For more information, see What is Resource Management?

      Instance Class

      DTS provides instance classes that vary in synchronization speed. You can select an instance class based on your business requirements. For more information, see Instance classes of data synchronization instances.

      Subscription Duration

      If you select the subscription billing method, specify the subscription duration and the number of data synchronization instances that you want to create. The subscription duration can be one to nine months, one year, two years, three years, or five years.

      Note

      This parameter is available only if you select the Subscription billing method.

    2. Read and select Data Transmission Service (Pay-as-you-go) Service Terms.

    3. Click Buy and Start. In the dialog box that appears, click OK.

      You can view the progress of the task in the task list.