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 instance by using Data Transmission Service (DTS).
Supported source and destination databases
Source database that uses the replica set architecture | Destination database that uses the replica set or sharded cluster architecture |
ApsaraDB for MongoDB database | ApsaraDB for MongoDB database |
Self-managed database that is hosted on an Elastic Compute Service (ECS) instance | Self-managed database that is hosted on an ECS instance |
Self-managed database connected over Express Connect, VPN Gateway, or Smart Access Gateway | Self-managed database connected over Express Connect, VPN Gateway, or Smart Access Gateway |
Self-managed database with a public IP address | Self-managed database with a public IP address |
In this example, the source database is an ApsaraDB for MongoDB replica set instance and the destination database is an ApsaraDB for MongoDB replica set or sharded cluster instance. You can also follow the procedure to configure data migration tasks for other types of MongoDB databases.
Prerequisites
The source ApsaraDB for MongoDB replica set instance and the destination ApsaraDB for MongoDB replica set or sharded cluster instance are created. For more information, see Create a replica set instance and Create a sharded cluster instance.
NoteFor more information about the supported database versions, see Overview of data migration scenarios.
The available storage space of the destination ApsaraDB for MongoDB instance is 10% larger than the total size of data in the source ApsaraDB for MongoDB instance. This is a recommended prerequisite.
If the destination ApsaraDB for MongoDB instance is a sharded cluster instance, databases and collections to be sharded are created, data sharding is configured, the balancer is enabled, and pre-sharding is performed in the destination ApsaraDB for MongoDB instance based on your business requirements. For more information, see Configure sharding to maximize the performance of shards and the "What do I do if the data of a MongoDB database deployed in the sharded cluster architecture is not evenly distributed?" section of the FAQ topic.
NoteAfter you configure sharding for a sharded cluster instance, the migrated data is distributed among different shards. This maximizes the performance of the sharded cluster. You can also enable the balancer and perform pre-sharding to prevent data skew.
Usage notes
Category | Description |
Limits on the source database |
|
Other limits |
|
Special cases | If the source database is a self-managed MongoDB database, take note of the following limits:
Note If you select an entire database as the object to be migrated, you can create a heartbeat table. The heartbeat table is updated or receives data every second. |
Billing
Migration type | Instance configuration fee | Internet traffic fee |
Schema migration and full data migration | Free of charge. | Charged only when data is migrated from Alibaba Cloud over the Internet. For more information, see Billing overview. |
Incremental data migration | Charged. For more information, see Billing overview. |
Migration types
Migration type | Description |
Schema migration | DTS migrates the schemas of the selected objects from the source ApsaraDB for MongoDB instance to the destination ApsaraDB for MongoDB instance. Note DTS supports schema migration for databases, collections, and indexes. |
Full data migration | DTS migrates full data of objects from the source ApsaraDB for MongoDB instance to the destination ApsaraDB for MongoDB instance. Note DTS supports full data migration for databases and collections. |
Incremental data migration | DTS migrates incremental data from the source ApsaraDB for MongoDB instance to the destination ApsaraDB for MongoDB instance. Use oplogA DTS task does not migrate incremental data from databases that are created after the task starts to run. DTS migrates incremental data generated by the following operations:
Use change streamsDTS migrates incremental data generated by the following operations:
|
Permissions required for database accounts
Database type | Schema migration | Full data migration | Incremental data migration |
Source ApsaraDB for MongoDB instance | Read permissions on the database to be migrated and the config database. | Read permission on the source database, the admin database, and the local database | |
Destination ApsaraDB for MongoDB instance | The dbAdminAnyDatabase permission, the read and write permissions on the destination database, and the read permissions on the local database. |
For more information about how to create a database account and grant permissions to the database account for an ApsaraDB for MongoDB instance, see Manage the permissions of MongoDB database users.
Procedure
Go to the Data Migration Tasks page.
Log on to the DMS console.
In the top navigation bar, move the pointer over Data Development.
Choose .
NoteThe actual operations may vary based on the mode and layout of the DMS console. For more information, see Simple mode and Customize the layout and style of the DMS console.
You can also go to the Data Migration Tasks page of the new DTS console.
Click Create Task to go to the task configuration page.
Optional. In the upper-right corner of the page, click New Configuration Page.
NoteSkip 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.
Configure the source and destination databases. The following table describes the parameters.
WarningAfter you configure the source and destination databases, we recommend that you read the Limits that are displayed in the upper part of the page. Otherwise, the task may fail or data inconsistency may occur.
Section
Parameter
Description
N/A
Task Name
The name of the task. DTS automatically generates a task name. We recommend that you specify an informative name to identify the task. You do not need to specify a unique task name.
Source Database
Select a DMS database instance
The database that you want to use. You can choose whether to use an existing database based on your business requirements.
If you select an existing database, DTS automatically populates the parameters for the database.
If you do not select an existing database, you must configure the following database information.
Database Type
The type of the source database. Select MongoDB.
Access Method
The access method of the source database. Select Alibaba Cloud Instance.
Instance Region
The region in which the source ApsaraDB for MongoDB instance resides.
Replicate Data Across Alibaba Cloud Accounts
Specifies whether to migrate data across Alibaba Cloud accounts. Select No.
Architecture
The architecture in which the source database is deployed. Select Replica Set.
Replica Set: You can deploy multiple types of nodes on a replica set instance to implement high availability and read/write splitting. For more information, see Replica set instances.
Sharded Cluster: A sharded cluster instance consists of three types of components: mongos, shard, and Configserver nodes. You can customize the configurations and number of mongos and shard nodes. For more information, see Sharded cluster instances.
Migration Method
The method used to migrate incremental data from the source database. Select a method based on your business requirements. Valid values:
Oplog (recommended):
This option is available if the oplog feature is enabled for the source database.
NoteBy default, the oplog feature is enabled for both self-managed MongoDB databases and ApsaraDB for MongoDB instances. This feature allows you to migrate incremental data at a low latency because of a fast log pulling speed. Therefore, we recommended that you select Oplog for the Migration Method parameter.
ChangeStream: This option is available if change streams are enabled for the source database. For more information, see Change Streams.
NoteIf the source database is an inelastic Amazon DocumentDB cluster, you can set the Migration Method parameter only to ChangeStream.
If you select Sharded Cluster for the Architecture parameter, you do not need to configure the Shard account and Shard password parameters.
Instance ID
The ID of the source ApsaraDB for MongoDB instance.
Authentication Database
The name of the authentication database that stores the database accounts and passwords of the source ApsaraDB for MongoDB instance. If you did not change the name of the authentication database before, the default value admin is used.
Database Account
The database account of the source ApsaraDB for MongoDB instance. For information about the permissions that are required for the account, see the "Permissions required for database accounts" section of this topic.
Database Password
The password that is used to access the database instance.
Encryption
Specifies whether to encrypt the connection to the source database. Select Non-encrypted or SSL-encrypted based on your business requirements.
NoteThis parameter is valid only if the source ApsaraDB for MongoDB instance is deployed in the Replica Set architecture.
If the source database is a self-managed ApsaraDB for MongoDB Replica Set instance and Encryption is set to SSL-encrypted, you can upload a certification authority (CA) certificate to verify the connection to the source database.
Destination Database
Select a DMS database instance
The database that you want to use. You can choose whether to use an existing database based on your business requirements.
If you select an existing database, DTS automatically populates the parameters for the database.
If you do not select an existing database, you must configure the following database information.
Database Type
The type of the destination database. Select MongoDB.
Access Method
The access method of the destination database. Select Alibaba Cloud Instance.
Instance Region
The region where the destination ApsaraDB for MongoDB instance resides.
Architecture
The architecture in which the destination instance is deployed. Select an architecture based on your business requirements. Valid values:
Replica Set: You can deploy multiple types of nodes on a replica set instance to implement high availability and read/write splitting. For more information, see Replica set instances.
Sharded Cluster: A sharded cluster instance consists of three types of components: mongos, shard, and Configserver nodes. You can customize the configurations and number of mongos and shard nodes. For more information, see Sharded cluster instances.
Instance ID
The ID of the destination ApsaraDB for MongoDB instance.
Authentication Database
The name of the authentication database that stores the database accounts and passwords of the destination ApsaraDB for MongoDB instance. If you did not change the name of the authentication database before, the default value admin is used.
Database Account
The database account of the destination ApsaraDB for MongoDB instance. For information about the permissions that are required for the account, see the "Permissions required for database accounts" section of this topic.
Database Password
The password that is used to access the database instance.
Encryption
Specifies whether to encrypt the connection to the destination database. Select Non-encrypted or SSL-encrypted based on your business requirements.
NoteThis parameter is valid only if the destination ApsaraDB for MongoDB instance is deployed in the Replica Set architecture.
If the destination database is a self-managed ApsaraDB for MongoDB Replica Set instance and Encryption is set to SSL-encrypted, you can upload a CA certificate to verify the connection to the destination database.
In the lower part of the page, click Test Connectivity and Proceed.
NoteMake sure that the CIDR blocks of DTS servers can be automatically or manually added to the security settings of the source and destination databases to allow access from DTS servers. For more information, see Add the CIDR blocks of DTS servers.
If the source or destination database is a self-managed database and its Access Method is not set to Alibaba Cloud Instance, click Test Connectivity in the CIDR Blocks of DTS Servers dialog box.
Configure the objects to be migrated and the advanced settings. The following table describes the parameters.
Parameter
Description
Migration Types
To perform only full data migration, select Schema Migration and Full Data Migration.
To ensure service continuity during data migration, select Schema Migration, Full Data Migration, and Incremental Data Migration.
NoteIf you do not select Incremental Data Migration, we recommend that you do not write data to the source database during data migration. This ensures data consistency between the source and destination databases.
For more information, see the "Migration types" section of this topic.
Processing Mode of Conflicting Tables
- Precheck and Report Errors: checks whether the destination database contains collections that have the same names as collections in the source database. If the source and destination databases do not contain identical collection names, the precheck is passed. Otherwise, an error is returned during the precheck, and the data migration task cannot be started. Note You can use the object name mapping feature to rename the collections that are migrated to the destination database. You can use this feature if the source and destination databases contain identical collection names and the collections 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 collection 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.
- DTS does not migrate data records that have the same primary keys as data records in the destination database.
- Data may fail to be initialized, only some columns are migrated, or the data migration task fails.
Capitalization of Object Names in Destination Instance
The capitalization of database names and collection names in the destination instance. By default, DTS default policy is selected. You can select another option to ensure that the capitalization of object names is the same as that of 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. Click the icon to add the objects to the Selected Objects section.
NoteYou can select databases or collections as the objects to be migrated.
Selected Objects
- To rename an object that you want to migrate 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.
NoteIf you use the object name mapping feature to rename an object, other objects that are dependent on the object may fail to be migrated.
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 Specify filter conditions.
Click Next: Advanced Settings to configure advanced settings. The following table describes the parameters.
Data Verification Settings
For more information about how to configure the data verification feature, see Configure a data verification task.
Advanced Settings
Parameter
Description
Dedicated Cluster for Task Scheduling
By default, DTS schedules the data migration task to the shared cluster if you do not specify a dedicated cluster. If you want to improve the stability of data migration tasks, purchase a dedicated cluster. For more information, see What is a DTS dedicated cluster.
Set Alerts
Specifies whether to configure alerting for the data migration task. If the task fails or the migration latency exceeds the specified threshold, the alert contacts receive notifications. Valid values:
No: does not configure alerting.
Yes: configures alerting. In this case, you must also configure the alert threshold and alert notification settings. For more information, see the Configure monitoring and alerting when you create a DTS task section of the Configure monitoring and alerting topic.
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 migration task is started, DTS immediately retries a connection within the retry time range. Valid values: 10 to 1440. Unit: minutes. Default value: 720. We recommend that you set the parameter to a value greater than 30. If DTS is reconnected to the source and destination databases within the specified retry time range, DTS resumes the data migration task. Otherwise, the data migration task fails.
NoteIf you specify different retry time ranges for multiple data migration tasks that share the same source or destination database, the value that is specified later 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 the earliest opportunity after the source database and destination instance are released.
Retry Time for Other Issues
The retry time range for other issues. For example, if DDL or DML operations fail to be performed after the data migration task is started, DTS immediately retries the operations within the retry time range. Valid values: 1 to 1440. Unit: minutes. Default value: 10. We recommend that you set the parameter to a value greater than 10. If the failed operations are successfully performed within the specified retry time range, DTS resumes the data migration task. Otherwise, the data migration task fails.
ImportantThe 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
Specifies whether to enable throttling for full data migration. During full data migration, DTS uses the read and write resources of the source and destination databases. This may increase the loads of the database servers. You can enable throttling for full data migration based on your business requirements. To configure throttling, you must 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. This reduces the loads of the destination database server.
NoteYou can configure this parameter only if you select Full Data Migration for the Migration Types parameter.
Enable Throttling for Incremental Data Migration
Specifies whether to enable throttling for incremental data migration. To configure throttling, you must configure the RPS of Incremental Data Migration and Data migration speed for incremental migration (MB/s) parameters. This reduces the loads of the destination database server.
NoteYou can configure this parameter only if you select Incremental Data Migration for the Migration Types parameter.
Environment Tag
The environment tag that is used to identify the DTS instance. You can select an environment tag based on your business requirements. In this example, you do not need to configure this parameter.
Configure ETL
Specifies whether to enable the extract, transform, and load (ETL) feature. For more information, see What is ETL? Valid values:
Yes: configures the ETL feature. You can enter data processing statements in the code editor. For more information, see Configure ETL in a data migration or data synchronization task.
No: does not configure the ETL feature.
In the lower part of the page, click Next: Save Task Settings and Precheck.
You can move the pointer over Next: Save Task Settings and Precheck and click Preview OpenAPI parameters to view the parameters to be specified when you call the relevant API operation to configure the DTS task.
NoteBefore you can start the data migration task, DTS performs a precheck. You can start the data migration task only after the task passes the precheck.
If the task fails to pass the precheck, click View Details next to each failed item. After you analyze the causes based on the check results, troubleshoot the issues. Then, run a precheck again.
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 issues. Then, run a precheck again.
If the 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.
Wait until Success Rate becomes 100%. Then, click Next: Purchase Instance.
On the Purchase Instance page, configure the Instance Class parameter for the data migration instance. The following table describes the parameters.
Section
Parameter
Description
New Instance Class
Resource Group
The resource group to which the data migration instance belongs. Default value: default resource group. For more information, see What is Resource Management?
Instance Class
DTS provides instance classes that vary in the migration speed. You can select an instance class based on your business scenario. For more information, see Instance classes of data migration instances.
Read and agree to Data Transmission Service (Pay-as-you-go) Service Terms by selecting the check box.
Click Buy and Start. In the message that appears, click OK.
You can view the progress of the task on the Data Migration page.