Data Transmission Service (DTS) supports two-way data synchronization between two ApsaraDB for MongoDB instances (sharded cluster architecture). This feature is applicable to scenarios such as active geo-redundancy (unit-based) and geo-disaster recovery. This topic describes how to configure two-way data synchronization between ApsaraDB for MongoDB instances.

Prerequisites

  • The source and destination ApsaraDB for MongoDB instances are created. For more information, see Create a sharded cluster instance.
    Note For more information about supported MongoDB versions, see Overview of data synchronization scenarios.
  • The available storage space of the destination ApsaraDB for MongoDB instance is larger than the total size of the data in the source ApsaraDB for MongoDB instance.
  • The replication.oplogGlobalIdEnabled parameter of the shard and Configserver nodes is set to true. For more information, see Configure database parameters for an ApsaraDB for MongoDB instance.
  • The source and destination ApsaraDB for MongoDB instances are deployed in a sharded cluster architecture. You must create databases and collections to be sharded in the source and destination ApsaraDB for MongoDB instances and configure sharding based on your business needs. For more information, see Configure sharding to maximize the performance of shards.
    Note
    • After you configure sharding for a cluster, the synchronized data will be distributed among different shards. This maximizes the performance of the sharded cluster.
    • The shard nodes in a sharded cluster instance must share the same account password and endpoint. For more information, see Apply for an endpoint for a shard or Configserver node.
    • In this scenario, you can configure a DTS task and then purchase a DTS instance. You do not need to specify the number of shards in the source ApsaraDB for MongoDB instance (sharded cluster architecture).

      If you purchase a DTS instance before you configure a DTS task, you must specify the number of shards when you purchase the instance.

Supported synchronization topologies

DTS supports two-way data synchronization only between two ApsaraDB for MongoDB instances (sharded cluster architecture). DTS does not support two-way data synchronization between multiple ApsaraDB for MongoDB instances.

Conflict detection

To ensure data consistency, make sure that data records with the same primary key, business primary key, or unique key are updated only on one of the synchronization nodes. If data records are updated on both nodes, DTS responds to conflicts based on the conflict resolution policy that you specify for the data synchronization task.

DTS checks and fixes conflicts to maximize the stability of two-way synchronization instances. DTS can detect the following types of conflicts:
  • Uniqueness conflicts caused by INSERT operations

    INSERT operations that do not comply with the uniqueness constraint cannot be synchronized. For example, if a record with the same primary key value is inserted into the two synchronization nodes at almost the same time, one of the inserted records fails to be synchronized. The synchronization fails because a record with the same primary key value already exists in the other node.

  • Inconsistent records caused by UPDATE operations
    • If the records to be updated do not exist in the destination instance, DTS converts the UPDATE operation into an INSERT operation. However, uniqueness conflicts may occur.
    • The primary keys or unique keys of the records to be inserted may conflict with those of existing records in the destination instance.
  • Non-existent records to be deleted

    The records to be deleted do not exist in the destination instance. In this case, DTS ignores the DELETE operation regardless of the conflict resolution policy that you specify.

Notice
  • During two-way synchronization, the system time of the source and destination instances may be different. Synchronization latency may occur. For these reasons, DTS cannot guarantee that the conflict detection mechanism can prevent all data conflicts. To perform two-way synchronization, make sure that records with the same primary key, business primary key, or unique key are updated only on one of the synchronization nodes.
  • DTS provides conflict resolution policies to prevent conflicts that may occur during data synchronization. You can select a conflict resolution policy when you configure two-way data synchronization.

Synchronization types

Synchronization type Description
Schema synchronization DTS synchronizes the schemas of the required objects from the source ApsaraDB for MongoDB instance to the destination ApsaraDB for MongoDB instance.
Full data synchronization DTS synchronizes historical data of the required objects from the source ApsaraDB for MongoDB instance to the destination ApsaraDB for MongoDB instance.
Note DTS supports full data synchronization for the following types of objects: database, collection, and index.
Incremental data synchronization DTS synchronizes incremental data from the source ApsaraDB for MongoDB instance to the destination ApsaraDB for MongoDB instance.
Note DTS supports the following types of incremental updates:
  • CREATE COLLECTION and CREATE INDEX
  • DROP COLLECTION and DROP INDEX
  • RENAME COLLECTION

Procedure

Notice In this scenario, you can configure a DTS task and then purchase a DTS instance. You do not need to specify the number of shards in the source ApsaraDB for MongoDB instance (sharded cluster architecture).

If you purchase a DTS instance before you configure a DTS task, you must specify the number of shards when you purchase the instance.

  1. Go to the Data Synchronization page of the new DTS console.
    Note You can also log on to the Data Management (DMS) console. In the top navigation bar, choose DTS > Data Synchronization.
  2. In the upper-left corner of the page, select the region where the data synchronization instance resides.
    Select a region
  3. In the upper-left corner of the page, select the region where the destination instance resides.
  4. Click Create Task. On the page that appears, configure the source and destination databases.
    Warning After you select the source and destination instances, we recommend that you read the limits displayed at the top of the page. This helps you create and run the data synchronization task.
    Configure the source and destination databases
    Section Parameter Description
    N/A Task Name

    DTS automatically generates a task name. We recommend that you specify an informative name to identify the task. You do not need to use a unique task name.

    Source Database Select Template
    If the connection settings of the instance has been saved as a template, you can select the connection name. DTS automatically applies the saved connection settings.
    Note
    • You can modify the connection settings of a template.
    • To edit the template name, you can click Edit Template Name at the bottom of the Source Database section.
    • The modified connection template will take effect the next time you select the connection template. The database instance that you have configured by using the template is not affected.
    Database Type Select MongoDB.
    Access Method Select Alibaba Cloud Instance.
    Instance Region Select the region where the source ApsaraDB for MongoDB instance resides.
    Architecture Select Sharded Cluster.
    Instance ID Select the ID of the source ApsaraDB for MongoDB instance.
    Database Name Enter the name of the source database in the ApsaraDB for MongoDB instance.
    Database Account Enter the database account of the source ApsaraDB for MongoDB instance. The account must have the read permissions on the source database, admin database, and local database.
    Database Password

    Enter the password of the database account.

    Shard Account Enter the shard account of the source ApsaraDB for MongoDB instance. For more information, see Apply for an endpoint for a shard or Configserver node.
    Shard Password Enter the shard password of the source ApsaraDB for MongoDB instance.
    Save as Template
    Click Save as Template. In the dialog box that appears, set the name of the database connection, and click OK. The connection settings of the database instance is saved as a template.
    Note We recommend that you specify an informative name to identify the database connection. You do not need to use a unique name.
    Destination Database Select Template
    If the connection settings of the instance has been saved as a template, you can select the connection name. DTS automatically applies the saved connection settings.
    Note
    • You can modify the connection settings of a template.
    • To edit the template name, you can click Edit Template Name at the bottom of the Source Database section.
    • The modified connection template will take effect the next time you select the connection template. The database instance that you have configured by using the template is not affected.
    Database Type Select MongoDB.
    Access Method Select Alibaba Cloud Instance.
    Instance Region Select the region where the destination ApsaraDB for MongoDB instance resides.
    Architecture Select Sharded Cluster.
    Instance ID Select the ID of the destination ApsaraDB for MongoDB instance.
    Database Name Enter the name of the destination database in the ApsaraDB for MongoDB instance.
    Database Account Enter the database account of the destination ApsaraDB for MongoDB instance. The account must have the dbAdminAnyDatabase permission, the read and write permissions on the destination database, and the read permissions on the local database.
    Database Password

    Enter the password of the database account.

    Shard Account Enter the shard account of the destination ApsaraDB for MongoDB instance.
    Shard Password Enter the shard password of the destination ApsaraDB for MongoDB instance.
    Save as Template
    Click Save as Template. In the dialog box that appears, set the name of the database connection, and click OK. The connection settings of the database instance is saved as a template.
    Note We recommend that you specify an informative name to identify the database connection. You do not need to use a unique name.
  5. In the lower part of the page, click Test Connectivity and Proceed.
  6. Select objects for the task and configure advanced settings.
    • Basic SettingsMongnDB: Basic Settings
      Parameter Description
      Task Stages

      Incremental Data Synchronization is selected by default. You must also select Schema Synchronization and Full Data Synchronization. After the precheck, DTS synchronizes the historical data of the selected objects from the source instance to the destination cluster. The historical data is the basis for subsequent incremental 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 identical table names, the precheck is passed. Otherwise, an error is returned during precheck and the data synchronization task cannot be started.

        Note You can use the object name mapping feature to rename the tables that are synchronized to the destination database. You can use this feature if the source and destination databases contain identical table names and the tables in the destination database cannot be deleted or renamed. 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 consistency is not guaranteed and your business may be exposed to potential risks.
        • If the source and destination databases have the same schema, and a data record has the same primary key as an existing data record in the destination 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.
      Synchronization Topology Select Two-way Synchronization.
      Exclude DDL Statements
      • To exclude DDL operations, select Yes.
      • To include DDL operations, select No.
        Note Limits on DDL synchronization direction: To ensure the stability of two-way data synchronization, you can synchronize DDL operations only in the forward direction.
      Conflict Resolution Policy If you encounter the conflicts described in Conflict detection, select a conflict resolution policy based on your business needs.
      • TaskFailed (If a conflict occurs, an error is reported and the task is stopped)

        If a conflict occurs during data synchronization, the synchronization task reports an error and exits the process. The task enters a failed state and you must manually resolve the conflict.

      • Ignore (If a conflict occurs, the conflicting record in the destination instance is used)

        If a conflict occurs during data synchronization, the synchronization task ignores the current statement and continues the process. The conflicting records in the destination database are used.

      • Overwrite (If a conflict occurs, the conflicting record in the destination instance is overwritten)

        If a conflict occurs during data synchronization, the conflicting records in the destination database are overwritten.

      Select Objects

      Select one or more objects from the Source Objects section and click the Rightwards arrow icon to move the objects to the Selected Objects section.

      Note You can select databases or collections as the objects to be synchronized.
      Rename Databases and Tables
      • 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 Map the name of a single object.
      • To rename multiple objects at a time, click Batch Edit in the upper-right corner of the Selected Objects section. For more information, see Map multiple object names at a time.
      Filter data

      You can specify WHERE conditions to filter data. For more information, see Use SQL conditions to filter data.

    • Advanced SettingsMongoDB: Advanced Settings
      Parameter Description
      Capitalization of Object Names in Destination Instance

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

      Retry Time for Failed Connection
      Specify the retry time for failed connections. Valid values: 10 to 1440. Unit: minutes. Default value: 120. We recommend that you set the retry time to more than 30 minutes. If DTS reconnects to the source and destination databases within the specified time, DTS resumes the data synchronization task. Otherwise, the data synchronization task fails.
      Note
      • If multiple DTS instances have the same source or destination database, the lowest value takes effect. For example, the retry time is set to 30 minutes for Instance A and 60 minutes for Instance B, DTS retries failed connections at an interval of 30 minutes.
      • When DTS retries a connection, you are charged for the DTS instance. We recommend that you specify the retry time based on your business needs. You can also release the DTS instance at your earliest opportunity after the source and destination instances are released.
  7. 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 task fails to pass the precheck, you can click the Info icon icon next to each failed item to view details.
      • You can troubleshoot the issues based on the causes and run a precheck again.
      • If you do not need to troubleshoot the issues, you can ignore failed items and run a precheck again.
  8. Wait until the Success Rate becomes 100%. Then, click Next: Purchase Instance.
  9. On the Purchase Instance page, specify the Billing Method and Instance Class parameters for the data synchronization instance. The following table describes the parameters.
    Section Parameter Description
    Parameters Billing Method
    • Subscription: You can pay for your subscription when you create an instance. We recommend that you select the subscription billing method for long-term use because it is more cost-effective than the pay-as-you-go billing method. You can save more costs with longer subscription periods.
    • Pay-as-you-go: A pay-as-you-go instance is billed on an hourly basis. We recommend that you select the pay-as-you-go billing method for short-term use. If you no longer require your pay-as-you-go instance, you can release it to reduce costs.
    Instance Class DTS provides several instance classes that have different performance in synchronization speed. You can select an instance class based on your business scenario. For more information, see Specifications of data synchronization instances.
    Subscription Length If you select the subscription billing method, set the subscription length and the number of instances that you want to create. The subscription length can be one to nine months or one to three years.
    Note This parameter is available only if you select the subscription billing method.
  10. Read and select Data Transmission Service (Pay-as-you-go) Service Terms.
  11. Click Buy and Start to start the data synchronization task in the forward direction. You can view the progress of the task in the task list.
  12. Wait until initial synchronization is completed and the data synchronization task in the forward direction is in the Running state. You can view the status of the data synchronization task on the Data Synchronization page.
  13. On the Data Synchronization page, click Create Task. On the page that appears, configure the source and destination databases, as described in Step 4.
    Notice When you configure the data synchronization task in the reverse direction, you must select the correct source and destination instances. The source instance in the reverse direction corresponds to the destination instance in the forward direction. The destination instance in the reverse direction corresponds to the source instance in the forward direction. You must also make sure that the parameter settings (such as the database name, account, and password) are consistent.
  14. Select objects for the task and configure advanced settings., as described in Step 6. We recommend that you specify the same settings. The following table provides additional description.
    Basic Settings
    Parameter Description
    Processing Mode of Conflicting Tables When DTS checks for conflicting tables in the reverse direction, the tables that have been synchronized to the destination instance are ignored.
    Select Objects We recommend that you select the same objects for the forward and reverse directions.

    You can also add or delete objects based on your business requirements.

    Rename Databases and Tables We recommend that you do not use this feature when you configure the task in the reverse direction. Otherwise, data inconsistency may occur.
  15. 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 task fails to pass the precheck, you can click the Info icon icon next to each failed item to view details.
      • You can troubleshoot the issues based on the causes and run a precheck again.
      • If you do not need to troubleshoot the issues, you can ignore failed items and run a precheck again.
  16. Wait until the Success Rate becomes 100%. Then, click Back.
  17. After the second data synchronization task is configured, wait until both tasks are in the Running state. The two-way data synchronization tasks are configured.