Updated on 2024-09-25 GMT+08:00

From AWS DocumentDB to DDS

Supported Source and Destination Databases

Table 1 Supported databases

Source DB

Destination DB

  • AWS DocumentDB (Replica set 4.0, replica set 5.0 and cluster 5.0)

    Note:

    1. The default version of an AWS DocumentDB cluster is 5.0.
    2. Replica sets support full+incremental, full, and incremental synchronization modes.
    3. Clusters support only the full synchronization mode.
    4. An Amazon DocumentDB instance-based cluster corresponds to a DDS replica set.
    5. An Amazon DocumentDB elastic cluster corresponds to a DDS cluster.

DDS DB instances (versions 3.4, 4.0, 4.2, and 4.4)

NOTE:

The destination database version must be the same as or later than the source database version.

Database Account Permission Requirements

To start a synchronization task, the source and destination database users must meet the requirements in the following table. Different types of synchronization tasks require different permissions. For details, see Table 2. DRS automatically checks the database account permissions in the pre-check phase and provides handling suggestions.

Table 2 Database account permissions

Type

Full+Incremental

Source database user

Replica set: The source database user must have the readAnyDatabase permission for the admin database.

Cluster: The source database user must have the readAnyDatabase permission for the admin database.

Destination database user

The destination database user must have the dbAdminAnyDatabase permission for the admin database and the readWrite permission for the destination database.

  • You are advised to create an independent database account for DRS task connection to prevent task failures caused by database account password modification.
  • After changing the account passwords for the source and destination databases, modify the connection information of the DRS task by referring to Modifying Connection Information to prevent automatic retry after a task failure. Automatic retry will lock the database accounts.

Supported Synchronization Objects

Table 3 lists the objects that can be synchronized in different scenarios. DRS will automatically check the objects you selected before the synchronization.

Table 3 Supported synchronization objects

Type

Notes

Synchronization objects

  • Replica set: Only collections (including validator and capped and non-capped collections), indexes, and views can be synchronized.
  • System databases (such as local, admin, and config) and system collections cannot be synchronized. If service data is in a system database, run renameCollection to move the service data to the user database.
  • The statement for creating a view cannot contain a regular expression.
  • Collections that contain the _id field without indexes are not supported.
  • The first parameter of BinData() cannot be 2.
  • Do not store non-UTF-8 character strings in the String field of the source database collection. Otherwise, data will be inconsistent before and after the synchronization.

Precautions

To ensure tasks can run normally, DRS provides automatic pre-check. Before starting a DRS task, DRS checks the configurations and conditions of the source and destination databases. For details about the main check items and handling suggestions, see "Pre-check Items". In addition to the pre-check items, you need to pay attention to the items listed in Table 4.

Table 4 Precautions

Type

Restrictions

Restrictions on the source database

  • During incremental synchronization, change streams of the source database must be enabled.
    1. To enable change streams for all collections on a specific database, authenticate to your Amazon DocumentDB cluster using the mongo shell and execute the following command: (replace db_name with the actual database name):

      db.adminCommand({modifyChangeStreams: 1,database: "db_name",collection: "", enable: true});

      If collection is set to an empty string, change streams is enabled for all collections within a given database. To enable change streams for a specific collection, specify the collection name. For more information, click here.

    2. The change streams retention period can be changed.

      The default retention period is three hours. You need to evaluate the migration duration based on the data volume and change the retention period to a value greater than or equal to the migration duration. If you do not know the time required for the migration, you are advised to set the retention period to seven days. After the migration is complete, change the retention period to an appropriate value. You can change the retention period through the console or CLI. For details, click here.

Restrictions on usage

General

  • To ensure data consistency, do not perform operations (including but not limited to DDL and DML operations) on the destination database during the synchronization.
  • During synchronization, do not modify or delete the usernames, passwords, permissions, or ports of the source and destination databases.
  • During task startup or full synchronization, you are not advised to perform DDL operations on the source database, such as deleting databases, collections, indexes, documents, or views. Otherwise, the synchronization may fail.
  • During the synchronization, data rollback caused by a primary/standby switchover of the source database is not supported.
  • Documents larger than 16 MB in the source database cannot be inserted or updated during full or incremental synchronization.

Incremental synchronization

  • If the source is a replica set instance, the following operations and commands are supported during incremental synchronization:
    • Adding, deleting, and updating documents
    • Deleting collections
    • The dropDatabase, dropCollection, and renameCollection DDL commands
  • In the incremental synchronization phase, concurrent replay is performed at the collection level to maintain the synchronization performance. In the following scenarios, only single-thread write is supported and concurrent replay is not supported:
    • The collection index contains a unique key.
    • The value of capped of the collection attribute is true.
  • In either of the preceding scenarios, the task delay may increase.

Troubleshooting

  • If any problem occurs during task creation, startup, full synchronization, incremental synchronization, or completion, rectify the fault by referring to Troubleshooting.

Other restrictions

  • Replica set: The AWS DocumentDB replica set instance must be available and have primary nodes.
  • The value of block_compressor is determined by stats().wiredTiger.creationString.block_compressor of the collection in the source database. If the destination database contains corresponding empty collections, the compression parameters will not be synchronized. If the compression parameters in the source database are not supported by the destination database, configure the compression parameters based on net.compression.compressors of the destination database. If the destination database version is DDS 4.2, DRS does not synchronize compression parameters because the destination database does not support compression parameter settings.
  • If the AWS DocumentDB service of the source database is deployed with other services on the same server, set the value of the cacheSizeGB parameter to the half of the minimum idle cache for the WiredTiger engine of the source database.
  • During an incremental synchronization of collections, renaming collections is not recommended.
  • Specify the information about all primary and secondary nodes of the replica set to prevent the primary/standby switchover from affecting the synchronization task. If you enter information about multiple primary and secondary nodes, ensure that all nodes belong to the same replica set instance.
  • To accelerate the synchronization, delete unnecessary indexes from the source database and retain only necessary indexes before the synchronization. You are advised not to create indexes for the source database during the synchronization. If indexes must be created, create them in the background.
  • To prevent loopback, do not start tasks that migrate the same database to and out of the cloud at the same time.
NOTE:

The source and destination databases in a synchronization task can be the same database. To avoid replication loop, you must rename object names.

Procedure

This section uses DDS replica set as an example to describe how to configure an AWS DocumentDB to DDS replica set synchronization task over a VPC network.

  1. On the Data Synchronization Management page, click Create Synchronization Task.
  2. On the Create Synchronization Instance page, select a region and project, specify the task name, description, and the synchronization instance details, and click Create Now.

    • Task information description
      Figure 1 Synchronization task information
      Table 5 Task information

      Parameter

      Description

      Region

      The region where the replication instance is deployed. You can change the region.

      Project

      The project corresponds to the current region and can be changed.

      Task Name

      The task name must start with a letter and consist of 4 to 50 characters. It can contain only letters, digits, hyphens (-), and underscores (_).

      Description

      The description consists of a maximum of 256 characters and cannot contain special characters !=<>'&"\

    • Synchronization instance details
    Figure 2 Synchronization instance details
    Table 6 Synchronization instance settings

    Parameter

    Description

    Data Flow

    Select To the cloud.

    The destination database must be a database on the current cloud.

    Source DB Engine

    Select AWS DocumentDB.

    Destination DB Engine

    Select DDS.

    Network Type

    AWS DocumentDB does not support public network access. For details, see Connection issues. You can only select VPN or Direct Connect.

    • VPN or Direct Connect is suitable for data synchronization from on-premises databases to cloud databases, between databases of different accounts in the same region on the cloud, or between databases across regions on the cloud using a VPN, Direct Connect, Cloud Connect, VPCEP, or a VPC peering connection.

    Destination DB Instance

    Select the DB instance you have created.

    Synchronization Instance Subnet

    Select the subnet where the synchronization instance is located. You can also click View Subnets to go to the network console to view the subnet where the instance resides. By default, the DRS instance and the destination DB instance are in the same subnet. You need to select the subnet where the DRS instance resides, and there are available IP addresses for the subnet. To ensure that the synchronization instance is successfully created, only subnets with DHCP enabled are displayed.

    Synchronization Mode

    The synchronization mode supported by a DRS task. Full+Incremental is used as an example. For details about the underlying working principles for full or incremental synchronization, see Product Architecture and Function Principles.

    Full+Incremental: This synchronization mode allows you to synchronize data without interrupting services. After a full synchronization initializes the destination database, an incremental synchronization initiates and parses logs to ensure data consistency between the source and destination databases.

    NOTE:

    If you select Full+Incremental, data generated during the full synchronization will be continuously synchronized to the destination database, and the source remains accessible.

    Source DB Instance Type

    If Synchronization Mode is set to Full+Incremental, set this parameter based on the source database. Currently, the source database supports only replica set, which is a non-cluster database.

    • Task type
      Figure 3 Task type
      Table 7 Task type information

      Parameter

      Description

      Specifications

      DRS instance specifications. Different specifications have different performance upper limits. For details, see Real-Time Synchronization.

      NOTE:

      DRS allows you to upgrade specifications only for single-AZ synchronization tasks. Task specifications cannot be downgraded. For details, see Changing Specifications.

      AZ

      Select the AZ where you want to create the DRS task. Selecting the one housing the source or destination database can provide better performance.

    • Enterprise Project and Tags
      Figure 4 Enterprise projects and tags
      Table 8 Enterprise Project and Tags

      Parameter

      Description

      Enterprise Project

      An enterprise project you would like to use to centrally manage your cloud resources and members. Select an enterprise project from the drop-down list. The default project is default.

      For more information about enterprise project, see Enterprise Management User Guide.

      To customize an enterprise project, click Enterprise in the upper right corner of the console. The Enterprise Project Management Service page is displayed. For details, see Creating an Enterprise Project in Enterprise Management User Guide.

      Tags

      • Tags a task. This configuration is optional. Adding tags helps you better identify and manage your tasks. Each task can have up to 20 tags.
      • If your organization has configured tag policies for DRS, add tags to tasks based on the policies. If a tag does not comply with the policies, task creation may fail. Contact your organization administrator to learn more about tag policies.
      • After a task is created, you can view its tag details on the Tags tab. For details, see Tag Management.

    If a task fails to be created, DRS retains the task for three days by default. After three days, the task automatically stops.

  1. On the Configure Source and Destination Databases page, wait until the synchronization instance is created. Then, specify source and destination database information and click Test Connection for both the source and destination databases to check whether they have been connected to the synchronization instance. After the connection tests are successful, click Next.

    • Source database information
    Figure 5 Source database information
    Table 9 Source database settings

    Parameter

    Description

    IP Address or Domain Name

    Example: docdb-2024-06-05-03-09-20.cluster-c58eyca06srk.ap-northeast-1.docdb.amazonaws.com:27017

    Authentication Database

    The name of the authentication database.

    Database Username

    The username for accessing the source database.

    Database Password

    The password for the database username.

    SSL Connection

    SSL encrypts the connections between the source and destination databases. If SSL is enabled, upload the SSL CA root certificate.

    NOTE:
    • The maximum size of a single certificate file that can be uploaded is 500 KB.
    • If SSL is disabled, your data may be at risk.

    The IP address, domain name, username, and password of the source database are encrypted and stored in the system until the task is deleted.

    • Destination database configuration
      Figure 6 Destination database information
    Table 10 Destination database settings

    Parameter

    Description

    DB Instance Name

    The DB instance you selected when creating the synchronization task. This parameter cannot be changed.

    Authentication Database

    The name of the authentication database. For example: The default authentication database of DDS instance is admin.

    Database Username

    The username for accessing the destination database.

    Database Password

    The password for the database username.

    SSL Connection

    SSL encrypts the connections between the source and destination databases. If SSL is enabled, upload the SSL CA root certificate.

    NOTE:
    • The maximum size of a single certificate file that can be uploaded is 500 KB.
    • If SSL is disabled, your data may be at risk.

    The username and password of the destination database are encrypted and stored in the database and the synchronization instance during the synchronization. After the task is deleted, the username and password are permanently deleted.

  1. On the Set Synchronization Task page, select the start point and synchronization objects, and click Next.

    Figure 7 Synchronization objects
    Table 11 Synchronization objects

    Parameter

    Description

    Flow Control

    You can choose whether to control the flow. Flow control is disabled by default. Flow Control takes effect in the full phase only.

    • Yes
    • You can customize the maximum synchronization speed. During the full synchronization, the synchronization speed of each task (or each subtask in multi-task mode) does not exceed the value of this parameter.
    • In addition, you can set the time range based on your service requirements. The flow control configuration usually includes settings of a flow control time range and a flow limit value. Flow can be controlled all day or during specific time ranges. The default value is Always. A maximum of three time ranges can be set, and they cannot overlap.
    • The flow rate must be set based on the service scenario and cannot exceed 9,999 MB/s.
      Figure 8 Flow control

    • No
    • The synchronization speed is not limited and the outbound bandwidth of the source database is maximally used, which causes read consumption on the source database accordingly. For example, if the outbound bandwidth of the source database is 100 MB/s and 80% bandwidth is used, the I/O consumption on the source database is 80 MB/s.
    NOTE:
    • Flow Control takes effect in the full phase only.
    • You can also change the flow control mode after creating a task. For details, see Modifying the Flow Control Mode.

    Synchronization Object

    The left pane displays the source database objects, and the right pane displays the selected objects. DRS supports table- and database-level synchronization. You can select data for synchronization based on your service requirements.

    If the synchronization objects in source and destination databases have different names, you can map the source object name to the destination one. For details, see Changing Object Names (Mapping Object Names). The mapped name can contain 1 to 63 characters. The following characters are not allowed /\."$<>

    If there are changes made to the source databases or objects, click in the upper right corner to update the objects to be synchronized.

    NOTE:
    • To quickly select the desired database objects, you can use the search function.
    • If there are changes made to the source databases or objects, click in the upper right corner to update the objects to be synchronized.
    • If an object name contains spaces, the spaces before and after the object name are not displayed. If there are two or more consecutive spaces in the middle of the object name, only one space is displayed.
    • The name of the selected synchronization object cannot contain spaces.

  1. On the Check Task page, check the synchronization task.

    • If any check fails, review the cause and rectify the fault. After the fault is rectified, click Check Again.

      For details about how to handle check failures, see Solutions to Failed Check Items in Data Replication Service User Guide.

    You can proceed to the next step only when all checks are successful. If there are any items that require confirmation, view and confirm the details first before proceeding to the next step.

  2. On the displayed page, specify Start Time, Send Notifications, SMN Topic, Delay Threshold (s), and Stop Abnormal Tasks After, confirm that the configured information is correct, select the check box before the agreement, and click Submit to submit the task.

    Figure 9 Task startup settings

    Table 12 Task startup settings

    Parameter

    Description

    Start Time

    Set Start Time to Start upon task creation or Start at a specified time based on site requirements.

    NOTE:

    After a synchronization task is started, the performance of the source and destination databases may be affected. You are advised to start a synchronization task during off-peak hours.

    Send Notifications

    This parameter is optional. After enabled, select a SMN topic. If the status, latency metric, or data of the migration task is abnormal, DRS will send you a notification.

    SMN Topic

    This parameter is available only after you enable Send Notifications and create a topic on the SMN console and add a subscriber.

    For details, see Simple Message Notification User Guide.

    Delay Threshold (s)

    During an incremental synchronization, a synchronization delay indicates a time difference (in seconds) of synchronization between the source and destination database.

    If the synchronization delay exceeds the threshold you specify, DRS will send alarms to the specified recipients. The value ranges from 0 to 3,600. To avoid repeated alarms caused by the fluctuation of delay, an alarm is sent only after the delay has exceeded the threshold for six minutes.

    NOTE:
    • If the delay threshold is set to 0, no notifications will be sent to the recipient.
    • In the early stages of an incremental synchronization, the synchronization delay is long because a large quantity of data is awaiting synchronization. In this case, no notifications will be sent.
    • Before setting the delay threshold, enable Send Notifications.

    Data Exception Notification

    This parameter is optional. After enabled, DRS will send a notification if the task data is abnormal.

    Stop Abnormal Tasks After

    Number of days after which an abnormal task is automatically stopped. The value must range from 14 to 100. The default value is 14.

    NOTE:
    • You can set this parameter only for pay-per-use tasks.
    • Tasks in the abnormal state are still charged. If tasks remain in the abnormal state for a long time, they cannot be resumed. Abnormal tasks run longer than the period you set (unit: day) will automatically stop to avoid unnecessary fees.

  3. After the task is submitted, you can view and manage it on the Data Synchronization Management page.

    • You can view the task status. For more information about task status, see Task Statuses.
    • You can click in the upper right corner to view the latest task status.
    • By default, DRS retains a task in the Configuration state for three days. After three days, DRS automatically deletes background resources, but the task status remains unchanged. When you configure the task again, DRS applies for resources for the task again. In this case, the IP address of the DRS instance changes.
    • For a public network task, DRS needs to delete background resources after you stop the task. The EIP bound to the task cannot be restored to the Unbound state until background resources are deleted.