This topic describes how to migrate data from an ApsaraDB for MongoDB replica set instance to an ApsaraDB for MongoDB replica set or sharded cluster by using Data Transmission Service (DTS).
Supported source and destination databases
Source database (replica set) | Destination database (replica set or sharded cluster) |
ApsaraDB for MongoDB | ApsaraDB for MongoDB |
Self-managed database on an ECS instance | Self-managed database on an ECS instance |
Self-managed database connected using Express Connect, VPN Gateway, or Smart Access Gateway | Self-managed database connected using Express Connect, VPN Gateway, or Smart Access Gateway |
Self-managed database with a public IP address | Self-managed database with a public IP address |
This topic provides an example configuration for a source ApsaraDB for MongoDB replica set and a destination ApsaraDB for MongoDB instance (replica set or sharded cluster). The configuration process for other data sources is similar.
Prerequisites
You have created a source ApsaraDB for MongoDB replica set instance and a destination ApsaraDB for MongoDB replica set or sharded cluster instance. For more information, see Create a replica set instance and Create a sharded cluster instance.
NoteFor information about supported versions, see Migration solutions overview.
The destination ApsaraDB for MongoDB instance should have 10% more storage space than the source ApsaraDB for MongoDB instance.
If the destination ApsaraDB for MongoDB instance is a sharded cluster, you must create the databases and collections that require sharding, configure data sharding, enable the balancer, and perform pre-sharding in the destination ApsaraDB for MongoDB instance based on your business needs. For more information, see Set up data sharding to fully utilize shard performance and How to handle uneven data distribution in a MongoDB sharded cluster.
NoteConfiguring data sharding prevents all data from being migrated to a single shard, ensuring optimal cluster performance; enabling the balancer and performing pre-sharding prevents data skew.
Notes
|
Type |
Description |
|
Source database limitations |
|
|
Other limitations |
|
|
Special cases |
If the source database is a self-managed MongoDB database:
Note
If you migrate an entire database, you can also create a heartbeat table that is updated at regular intervals, such as every second. |
Billing
|
Migration type |
Instance configuration fee |
Internet traffic fee |
|
Schema migration and full data migration |
Free of charge. |
When the Access Method parameter of the destination database is set to Public IP Address, you are charged for Internet traffic. For more information, see Billing overview. |
|
Incremental data migration |
Charged. For more information, see Billing overview. |
Migration types
Type | Description |
schema migration | Migrate the schema of the migration objects from the source ApsaraDB for MongoDB to the destination ApsaraDB for MongoDB. Note Schema migration is supported for databases, collections, and indexes. |
full data migration | Migrate all existing data of the migration objects from the source ApsaraDB for MongoDB to the destination ApsaraDB for MongoDB. Note Full data migration is supported for data in databases and collections. |
incremental data migration | In addition to the full migration, you can migrate incremental updates from the source ApsaraDB for MongoDB to the destination ApsaraDB for MongoDB. OplogIncremental migration does not support databases that are created after the task starts. The following incremental updates are supported:
Change streamThe following incremental updates are supported:
|
Database account permissions
Database | Schema migration | Full data migration | Incremental data migration |
Source ApsaraDB for MongoDB instance | Read permission on the database to be migrated and the config database. | Read permission on the database to be migrated, the admin database, and the local database. | |
Destination ApsaraDB for MongoDB instance | dbAdminAnyDatabase, readWrite on the destination database, and read on the local database. | ||
To create database accounts and grant permissions for the source and destination ApsaraDB for MongoDB instances, see Manage MongoDB database users with DMS.
Procedure
-
Navigate to the migration task list page for the destination region using one of the following methods.
From the DTS console
-
Log on to the Data Transmission Service (DTS) console.
-
In the navigation pane on the left, click Data Migration.
-
In the upper-left corner of the page, select the region where the migration instance is located.
From the DMS console
NoteThe actual operations may vary based on the mode and layout of the DMS console. For more information, see Simple mode console and Customize the layout and style of the DMS console.
-
Log on to the Data Management (DMS) console.
-
In the top menu bar, choose .
-
To the right of Data Migration Tasks, select the region where the migration instance is located.
-
-
Click Create Task to navigate to the task configuration page.
Configure the source and destination databases.
WarningAfter you select the source and destination instances, we recommend that you carefully read the limits displayed at the top of the page. Otherwise, the task may fail or data inconsistency may occur.
Category
Parameter
Description
N/A
Task Name
DTS automatically generates a task name. We recommend that you specify a descriptive name for easy identification. The name does not need to be unique.
Source Database
Select Existing Connection
-
To use a database instance that has been added to the system (created or saved), select the desired database instance from the drop-down list. The database information below will be automatically configured.
NoteIn the DMS console, this parameter is named Select a DMS database instance..
-
If you have not registered the database instance with the system, or do not need to use a registered instance, manually configure the database information below.
Database Type
Select MongoDB.
Connection Type
Select Cloud instance.
Instance Region
Select the region where the source ApsaraDB for MongoDB instance is located.
Replicate Data Across Alibaba Cloud Accounts
In this example, a database instance under the current Alibaba Cloud account is used. Select No.
Architecture
Select Replica Set.
Replica Set: This architecture uses multiple nodes to ensure high availability and enable read/write splitting. For more information, see Replica set architecture.
Sharded Cluster: This architecture consists of mongos, shard, and ConfigServer components. You can customize the number and configurations of mongos and shard nodes. For more information, see Sharded cluster architecture.
Migration Method
Select a method for incremental data migration based on your requirements.
Oplog (Recommended):
This option is available if an oplog is enabled for the source database.
NoteAn oplog is enabled by default for both self-managed MongoDB databases and ApsaraDB for MongoDB instances. This method offers lower latency for incremental data migration due to faster log pulling. Therefore, we recommend selecting Oplog.
ChangeStream: This option is available if Change Streams are enabled for the source database.
NoteIf the source database is an Amazon DocumentDB instance (non-elastic cluster), you can only select ChangeStream.
If you set Architecture to Sharded Cluster for the source database, you do not need to enter a Shard account or Shard password.
Instance ID
Select the instance ID of the source ApsaraDB for MongoDB instance.
Authentication Database
Enter the name of the database to which the database account of the source ApsaraDB for MongoDB instance belongs. The default value is admin.
Database Account
Enter the database account of the source ApsaraDB for MongoDB instance. For information about permission requirements, see Database account permissions.
Database Password
Enter the password for the database account.
Encryption
DTS supports three connection methods: Non-encrypted, SSL-encrypted, and Mongo Atlas SSL. The options for Encryption vary based on the selected Access Method and Architecture. The options displayed in the console prevail.
NoteA MongoDB database where the Architecture is Sharded Cluster and the Migration Method is Oplog does not support SSL-encrypted.
If the source is a self-managed MongoDB database (Access Method is not Alibaba Cloud Instance) with a Replica Set architecture, and you select SSL-encrypted, DTS also allows you to upload a CA certificate to verify the connection.
Destination Database
Select Existing Connection
-
To use a database instance that has been added to the system (created or saved), select the desired database instance from the drop-down list. The database information below will be automatically configured.
NoteIn the DMS console, this parameter is named Select a DMS database instance..
-
If you have not registered the database instance with the system, or do not need to use a registered instance, manually configure the database information below.
Database Type
Select MongoDB.
Connection Type
Select Cloud instance.
Instance Region
Select the region where the destination ApsaraDB for MongoDB instance is located.
Replicate Data Across Alibaba Cloud Accounts
In this example, a database instance under the current Alibaba Cloud account is used. Select No.
Architecture
Select an architecture based on your business requirements. Valid values:
Replica Set: This architecture uses multiple nodes to ensure high availability and enable read/write splitting. For more information, see Replica set architecture.
Sharded Cluster: This architecture consists of mongos, shard, and ConfigServer components. You can customize the number and configurations of mongos and shard nodes. For more information, see Sharded cluster architecture.
Instance ID
Select the instance ID of the destination ApsaraDB for MongoDB instance.
Authentication Database
Enter the name of the database to which the database account of the destination ApsaraDB for MongoDB instance belongs. The default value is admin.
Database Account
Enter the database account of the destination ApsaraDB for MongoDB instance. For information about permission requirements, see Database account permissions.
Database Password
Enter the password for the database account.
Encryption
DTS supports three connection methods: Non-encrypted, SSL-encrypted, and Mongo Atlas SSL. The options for Encryption vary based on the selected Access Method and Architecture. The options displayed in the console prevail.
NoteMongoDB databases with an Architecture of Sharded Cluster do not support SSL-encrypted.
If the destination is a self-managed MongoDB database (Access Method is not Alibaba Cloud Instance) with a Replica Set, and you select SSL-encrypted, DTS also allows you to upload a CA certificate to verify the connection.
-
After completing the configuration, click Test Connectivity and Proceed at the bottom of the page.
NoteEnsure that you add the CIDR blocks of the DTS servers (either automatically or manually) to the security settings of both the source and destination databases to allow access. For more information, see Add the IP address whitelist of DTS servers.
If the source or destination is a self-managed database (i.e., the Access Method is not Alibaba Cloud Instance), you must also click Test Connectivity in the CIDR Blocks of DTS Servers dialog box.
Configure the task objects.
On the Configure Objects page, configure the objects that you want to migrate.
Parameter
Description
Migration Types
-
If you only need to perform a full migration, select both Schema Migration and Full Data Migration.
-
To perform a migration with no downtime, select Schema Migration, Full Data Migration, and Incremental Data Migration.
Note-
If you do not select Schema Migration, you must ensure that a database and tables to receive the data exist in the destination database. You can also use the object name mapping feature in the Selected Objects box as needed.
-
If you do not select Incremental Data Migration, do not write new data to the source instance during data migration to ensure data consistency.
For more information, see Migration types.
Processing Mode of Conflicting Tables
-
Precheck and Report Errors: Checks whether collections with the same names exist in the destination database. If no collections with the same names exist, the precheck is passed. If collections with the same names exist, an error is reported during the precheck, and the data migration task does not start.
NoteIf a collection in the destination database has the same name but cannot be easily deleted or renamed, you can change the name of the collection in the destination database. For more information, see Object name mapping.
-
Ignore Errors and Proceed: Skips the check for collections with the same names.
WarningSelecting Ignore Errors and Proceed may cause data inconsistency and business risks. For example:
-
If a record in the destination database has the same primary key value as a record in the source database, the record in the destination database is kept. The record from the source database is not migrated to the destination database.
-
Data initialization may fail, only some data may be migrated, or the migration may fail.
-
Capitalization of Object Names in Destination Instance
You can configure the case policy for the names of migrated databases and collections in the destination instance. By default, DTS default policy is selected. You can also choose to align with the default policies of the source or destination database. For more information, see Object name case policy for the destination.
Source Objects
In the Source Objects box, click the object that you want to migrate, and then click
to move it to the Selected Objects box.NoteYou can select objects at the DATABASE or COLLECTION level.
Selected Objects
-
To set the name of a migration object in the destination instance, or to specify the object that receives data in the destination instance, right-click the migration object in the Selected Objects box to make changes. For more information, see Object name mapping.
-
To remove a selected migration object, click the object in the Selected Objects box, and then click
to move it to the Source Objects box.
NoteTo select incremental migration operations at the database or collection level, right-click the migration object in the Selected Objects box and make your selection in the dialog box that appears.
To set conditions to filter data (supported during full data migration but not incremental data migration), right-click the collection in the Selected Objects box and configure the settings in the dialog box that appears. For instructions, see Set filter conditions.
If you use the object name mapping feature to specify a database or collection to receive data, the migration of other objects that depend on this object might fail.
Click Next: Advanced Settings to configure advanced parameters.
Parameter
Description
Dedicated Cluster for Task Scheduling
By default, DTS schedules tasks on a shared cluster. You do not need to select one. If you want more stable tasks, you can purchase a dedicated cluster to run DTS migration tasks.
Retry Time for Failed Connections
After the migration task starts, if the connection to the source or destination database fails, DTS reports an error and immediately begins to retry the connection. The default retry duration is 720 minutes. You can customize the retry time to a value from 10 to 1440 minutes. We recommend that you set the duration to more than 30 minutes. If DTS reconnects to the source and destination databases within the specified duration, the migration task automatically resumes. Otherwise, the task fails.
Note-
For multiple DTS instances that share the same source or destination, the network retry time is determined by the setting of the last created task.
-
Because you are charged for the task during the connection retry period, we recommend that you customize the retry time based on your business needs, or release the DTS instance as soon as possible after the source and destination database instances are released.
Retry Time for Other Issues
After the migration task starts, if a non-connectivity issue, such as a DDL or DML execution exception, occurs in the source or destination database, DTS reports an error and immediately begins to retry the operation. The default retry duration is 10 minutes. You can customize the retry time to a value from 1 to 1440 minutes. We recommend that you set the duration to more than 10 minutes. If the related operations succeed within the specified retry duration, the migration task automatically resumes. Otherwise, the task fails.
ImportantThe value of Retry Time for Other Issues must be less than the value of Retry Time for Failed Connections.
Enable Throttling for Full Data Migration
During full migration, DTS consumes read and write resources on the source and destination databases, which may increase the database load. If required, you can enable throttling for the full migration task. You can set Queries per second (QPS) to the source database, RPS of Full Data Migration, and Data migration speed for full migration (MB/s) to reduce the load on the destination database.
Note-
This configuration item is available only if you select Full Data Migration for Migration Types.
-
You can also adjust the full migration speed after the migration instance is running.
Only one data type for primary key _id in a table of the data to be synchronized
In the data to be migrated, is the data type of the primary key
_iduniform within a single collection?ImportantSelect an option based on your requirements. Otherwise, data loss may occur.
This parameter is available only if you select Full Data Migration for Migration Types.
Yes: The data type is unique. During full data migration, DTS does not scan the data types of primary keys in the source data. For a single collection, DTS migrates only the data corresponding to one primary key data type.
No: The data type is not unique. During full data migration, DTS scans the data types of primary keys in the source data and migrates all data.
Enable Throttling for Incremental Data Migration
If required, you can also choose to set speed limits for the incremental migration task. You can set RPS of Incremental Data Migration and Data migration speed for incremental migration (MB/s) to reduce the load on the destination database.
Note-
This configuration item is available only if you select Incremental Data Migration for Migration Types.
-
You can also adjust the incremental migration speed after the migration instance is running.
Environment Tag
You can select an environment tag to identify the instance. This is optional for this example.
Configure ETL
Based on your business needs, select whether to configure the ETL feature to process data.
-
Yes: Configures the ETL feature. You must also enter data processing statements in the text box.
-
No: Does not configure the ETL feature.
Monitoring and Alerting
Select whether to set alerts and receive alert notifications based on your business needs.
-
No: Does not set an alert.
-
Yes: Configure alerts by setting an alert threshold and an alert contact. If a migration fails or the latency exceeds the threshold, the system sends an alert notification.
-
-
Click Next: Data Validation to configure a data validation task.
For more information about the data validation feature, see Configure data validation.
-
-
Save the task and run a precheck.
-
To view the parameters for configuring this instance when you call the API operation, move the pointer over the Next: Save Task Settings and Precheck button and click Preview OpenAPI parameters in the bubble that appears.
-
If you do not need to view or have finished viewing the API parameters, click Next: Save Task Settings and Precheck at the bottom of the page.
Note-
Before the migration task starts, DTS performs a precheck. The task starts only after it passes the precheck.
-
If the precheck fails, click View Details next to the failed check item, fix the issue based on the prompt, and then run the precheck again.
-
If a warning is reported during the precheck:
-
For check items that cannot be ignored, click View Details next to the failed item, fix the issue based on the prompt, and then run the precheck again.
-
For check items that can be ignored, you can click Confirm Alert Details, Ignore, OK, and Precheck Again to skip the alert item and run the precheck again. If you choose to ignore a warning, it may cause issues such as data inconsistency and pose risks to your business.
-
-
Purchase the instance.
-
When the Success Rate is 100%, click Next: Purchase Instance.
-
On the Purchase page, select the link specification for the data migration instance. For more information, see the following table.
Category
Parameter
Description
New Instance Class
Resource Group Settings
Select the resource group to which the instance belongs. The default value is default resource group. For more information, see What is Resource Management?
Instance Class
DTS provides migration specifications with different performance levels. The link specification affects the migration speed. You can select a specification based on your business scenario. For more information, see Data migration link specifications.
-
After the configuration is complete, read and select Data Transmission Service (Pay-as-you-go) Service Terms.
-
Click Buy and Start. In the OK dialog box that appears, click OK.
You can view the progress of the migration task on the Data Migration Tasks list page.
Note-
If the migration task does not include incremental migration, it stops automatically after the full migration is complete. After the task stops, its Status changes to Completed.
-
If the migration task includes incremental migration, it does not stop automatically. The incremental migration task continues to run. While the incremental migration task is running, the Status of the task is Running.
-
-
FAQ
Why do I encounter task latency and data inconsistency even when there are no application writes?
Cause: This issue occurs because of a conflict between the automatic deletion mechanism of a TTL index on a MongoDB collection and the data synchronization mechanism of DTS. This conflict can lead to task latency and data inconsistency in your synchronization/migration task.
-
Redundant DELETEs reduce efficiency: When the source TTL index deletes expired data, it writes a DELETE record to the Oplog. DTS replays this DELETE on the destination. If the destination TTL index already deleted the same data, MongoDB returns an unexpected affected-row count, triggering exception handling and slowing the migration.
-
Data inconsistency from asynchronous TTL deletion: TTL indexes do not delete data in real time. Expired data may still exist on the source while the destination has already deleted it, causing inconsistency.
Example:
The MongoDB Oplog or ChangeStream records only the updated fields for an UPDATE operation, not the full document. If an UPDATE cannot find the target data on the destination, DTS ignores the operation.
Timing
Source instance
Destination instance
1
Service inserts data
2
DTS synchronizes the INSERT operation
3
Data has expired but is not yet deleted by the TTL index
4
Service updates the data (for example, updates the TTL index field to change the expiration time)
5
TTL index deletes the data
6
DTS synchronizes the UPDATE, but the data is not found. The operation is ignored.
As a result, this document is missing from the destination MongoDB instance.
-
Solution: To resolve this, temporarily modify the expiration time of the TTL index on the target during the synchronization/migration task. This ensures both synchronization efficiency and data consistency. For detailed steps, see Best practices for synchronizing or migrating collections with TTL indexes from a MongoDB source.