This topic describes how to use Data Transmission Service (DTS) to migrate data from a self-managed MongoDB database that uses the sharded cluster architecture to an ApsaraDB for MongoDB replica set or sharded cluster instance. DTS allows you to migrate the existing and incremental data of on-premises databases to Alibaba Cloud without service interruptions.
Prerequisites
The destination ApsaraDB for MongoDB replica set or sharded cluster instance is created. For more information, see Create a replica set instance or Create a sharded cluster instance.
ImportantThe available storage space of the destination ApsaraDB for MongoDB sharded cluster instance is 10% larger than the total size of the data in the source self-managed MongoDB database. This is a recommended prerequisite.
For more information about the supported database versions, see Overview of data migration scenarios.
The account that is used to access the shards in the source self-managed MongoDB database is created, and the shards share the same account and password.
If the destination ApsaraDB for MongoDB instance is a sharded cluster instance:
Each shard in the destination sharded cluster instance has sufficient storage space.
NoteFor example, a self-managed MongoDB database has three shards, and one of these shards occupies a maximum storage space of 500 GB. In this case, the storage space of each shard in the destination instance must be larger than 500 GB.
Databases and collections to be sharded are created and data sharding is configured in the destination ApsaraDB for MongoDB sharded cluster instance based on your business requirements. The balancer is enabled, and pre-sharding is performed. 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 |
|
Billing
Migration type | Task configuration fee | Data transfer cost |
Schema migration and full data migration | Free of charge | Free of charge |
Incremental data migration | Charged. For more information, see Billing overview. |
Migration types
Migration type | Description |
Schema migration | DTS migrates the schemas of the objects to be migrated from the source self-managed MongoDB database instance to the destination ApsaraDB for MongoDB instance. |
Full data migration | DTS migrates the existing data of the objects to be migrated from the source self-managed MongoDB database instance to the destination ApsaraDB for MongoDB instance. Note DTS supports full data migration for databases and collections. |
Incremental data migration | After full data migration is completed, DTS migrates incremental data from the source self-managed MongoDB database instance to the destination ApsaraDB for MongoDB instance. Note DTS migrates incremental data generated by the following operations:
|
Permissions required for database accounts
Database type | Schema migration | Full data migration | Incremental data migration |
Self-managed MongoDB database | The read permissions on the database to be migrated and the config database. | Read permissions on the source database. | Read permissions on the source database, the admin database, and the local database. |
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 information about how to create and authorize a database account, see the following topics:
Self-managed MongoDB database: db.createUser()
ApsaraDB for MongoDB instance: Manage user permissions on MongoDB databases
Preparations
Required: Disable the balancer of the self-managed MongoDB database. This prevents the impact of chunk migration on data consistency. For more information, see Manage the ApsaraDB for MongoDB balancer.
WarningIf the balancer is not disabled, chunk migration affects the consistency of the data read by DTS.
Delete the orphaned documents that are generated due to chunk migration failures from the self-managed MongoDB database.
NoteIf you do not delete the orphaned documents, the migration performance will be compromised. In addition, some documents may have duplicate
_id
values and data that you do not want to migrate may be migrated.Download the cleanupOrphaned.js file.
wget "https://docs-aliyun.cn-hangzhou.oss.aliyun-inc.com/assets/attach/120562/cn_zh/1564451237979/cleanupOrphaned.js"
Replace
test
in the cleanupOrphaned.js file with the name of the database from which you want to delete orphaned documents.NoteIf you want to delete orphaned documents from multiple databases, repeat Substep b and Substep c in Step 2.
Run the following command on a shard to delete the orphaned documents from all collections in the specified database:
NoteYou must repeat this step on each shard.
mongo --host <Shardhost> --port <Primaryport> --authenticationDatabase <database> -u <username> -p <password> cleanupOrphaned.js
Note<Shardhost>: the IP address of the shard.
<Primaryport>: the service port of the primary node in the shard.
<database>: the name of the database to which the database account belongs.
<username>: the account that is used to log on to the self-managed MongoDB database.
<password>: the password that is used to log on to the self-managed MongoDB database.
Example:
In this example, a self-managed MongoDB database has three shards, and you must delete the orphaned documents on each shard.
mongo --host 172.16.1.10 --port 27018 --authenticationDatabase admin -u dtstest -p 'Test123456' cleanupOrphaned.js
mongo --host 172.16.1.11 --port 27021 --authenticationDatabase admin -u dtstest -p 'Test123456' cleanupOrphaned.js
mongo --host 172.16.1.12 --port 27024 --authenticationDatabase admin -u dtstest -p 'Test123456' cleanupOrphaned.js
Create databases and collections to be sharded in the destination ApsaraDB for MongoDB instance, and configure data sharding based on your business requirements. For more information, see Configure sharding to maximize the performance of shards.
NoteIf you configure data sharding before you start data migration, data in the self-managed MongoDB database is evenly migrated to the shards in the destination sharded cluster instance. This prevents the overloading of a single shard.
Procedure
Go to the Data Migration Tasks page.
Log on to the Data Management (DMS) console.
In the top navigation bar, move the pointer over DTS.
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 page of the new DTS console.
From the drop-down list on the right side of Data Migration Tasks, select the region in which your data migration instance resides.
NoteIf you use the new DTS console, you must select the region in which the data migration instance resides in the upper-left corner.
Click Create Task. In the Create Data Migration Task wizard, 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
None
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 an existing DMS database instance. (Optional. If you have not registered a DMS database instance, ignore this option and configure database settings in the section below.)
The database instance that you want to use. You can choose whether to use an existing instance based on your business requirements.
If you select an existing instance, DTS automatically populates the parameters for the database.
If you do not select an existing instance, you must manually configure parameters for the database.
Database Type
The type of the source database. Select MongoDB.
Access Method
The access method of the source database. In this example, Public IP Address is selected.
NoteIf you choose other methods to access the source self-managed MongoDB database, you must deploy the network environment for the database. For more information, see Preparation overview.
Instance Region
The region in which the source self-managed MongoDB database resides.
NoteIf the region in which the self-managed MongoDB database resides is not displayed in the drop-down list, select a region that is geographically closest to the self-managed MongoDB database.
Architecture
The architecture in which the source database is deployed. Select Sharded Cluster.
NoteThe Sharded Cluster option appears only if you set the Access Method parameter to Express Connect, VPN Gateway, or Smart Access Gateway, Public IP Address, or Cloud Enterprise Network (CEN).
Endpoint Type
Select Standalone or Multi-node based on your business needs.
NoteThis parameter appears only if you set the Access Method parameter to Express Connect, VPN Gateway, or Smart Access Gateway, Public IP Address, or Cloud Enterprise Network (CEN).
Domain Name or IP
The endpoint or IP address of a mongos node in the self-managed MongoDB database. In this example, the public IP address of a mongos node is used.
NoteThis parameter appears only if the Endpoint Type parameter is set to Standalone.
Set the Domain Name or IP parameter to the domain name or IP address of any mongos node. Set the Port Number parameter to the port of any mongos node.
Port Number
The service port number of the self-managed MongoDB database.
NoteThis parameter appears only if the Endpoint Type parameter is set to Standalone.
The service port of the mongos node must be accessible over the Internet.
Endpoint
The endpoint of the self-managed MongoDB database.
NoteThis parameter appears only if the Endpoint Type parameter is set to Multi-node.
Specify the parameter in the
<IP>:<Port>
format. Replace<IP>
with the domain name or an IP address. We recommend that you use a domain name that can be accessed over the Internet.Separate multiple endpoints with line feeds.
Authentication Database
The name of the authentication database that stores the database accounts and passwords of the source self-managed MongoDB database. If you did not change the name of the authentication database before, the default value is admin.
Database Account
The account that is used to access the mongos nodes in the self-managed MongoDB database. For more information about the permissions that are required for the account, see the Permissions required for database accounts section of this topic.
NoteIf you set the Access Method parameter to Self-managed Database on ECS or Database Gateway, enter the account that is used to access the shards in the self-managed MongoDB database.
Database Password
The password that is used to access the database instance.
Access to Multiple Shard Nodes
The information that is used to access the shard nodes of the self-managed MongoDB database.
NoteThis parameter is available only if the self-managed MongoDB database is the source database, the Architecture parameter is set to Sharded Cluster, and the Endpoint Type parameter is set to Multi-node.
Click Add to the right of Access to Multiple Shard Nodes.
In the Shard Node Endpoint field, enter the endpoint of a shard node of the self-managed MongoDB database.
NoteAn endpoint is in the
<IP>:<Port>
format. Replace<IP>
with a domain name or an IP address. We recommend that you use a domain name that is publicly resolvable.Separate multiple endpoints with line feeds.
Repeat the preceding steps to configure the access information for each shard node.
Shard access information (IP:Port)
The access information about the shards in the self-managed MongoDB database, including the IP address and port number of the shards. The format is
IP address:Port number
.NoteThis parameter appears only if the Endpoint Type parameter is set to Standalone.
Separate the access information of multiple shards with commas (,).
Shard account
The account that is used to access the shards in the source self-managed MongoDB database.
Shard password
The password that is used to access the shards in the source self-managed MongoDB database.
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 an existing DMS database instance. (Optional. If you have not registered a DMS database instance, ignore this option and configure database settings in the section below.)
The database instance that you want to use. You can choose whether to use an existing instance based on your business requirements.
If you select an existing instance, DTS automatically populates the parameters for the database.
If you do not select an existing instance, you must manually configure parameters for the database.
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 in which the destination ApsaraDB for MongoDB instance resides.
Architecture
The architecture in which the destination ApsaraDB for MongoDB instance is deployed.
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 is admin.
Database Name
The name of the database to which the migrated objects in the destination ApsaraDB for MongoDB instance belong.
Database Account
The database account of the destination ApsaraDB for MongoDB instance. For more 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.
If an IP address whitelist is configured for your self-managed database, add the CIDR blocks of DTS servers to the IP address whitelist. Then, click Test Connectivity.
WarningIf the public CIDR blocks of DTS servers are automatically or manually added to the whitelist of a database instance or to the security group rules of an ECS instance, security risks may arise. Therefore, before you use DTS to migrate 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 security group rules and forbidding unauthorized CIDR blocks, or connecting the database instance to DTS by using Express Connect, VPN Gateway, or Smart Access Gateway.
Configure the objects to be migrated and advanced settings.
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.
Processing Mode of Conflicting Tables
Precheck and Report Errors: checks whether the destination database contains tables that use 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 migration task cannot be started.
NoteIf 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 migrated 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.
WarningIf you select Ignore Errors and Proceed, data inconsistency may occur and your business may be exposed to the following 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, the following scenarios may occur:
During full data migration, DTS does not migrate the data record to the destination database. The existing data record in the destination database is retained.
During incremental data migration, DTS migrates 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, only specific columns are migrated or the data migration task fails. Proceed with caution.
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 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.
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 collections or databases 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.
Filter statements supported by ApsaraDB for MongoDB instances are different from standard SQL WHERE statements. To specify WHERE conditions to filter data, right-click an object 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.
Data Verification Settings
For more information about how to use 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. You can also purchase a dedicated cluster of the required specifications to run the data migration task. For more information, see What is a DTS dedicated cluster.
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 change tracking 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.
Monitoring and Alerting
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 Configure monitoring and alerting when you create a DTS task.
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 Settings
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 Specifications 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 dialog box that appears, click OK.
You can view the progress of the task in the task list.
Optional. If you set the Access Method parameter to Self-managed Database on ECS or Database Gateway for the source self-managed MongoDB database, you need to repeat Steps 1 to 12 to create data migration tasks for the remaining shards.
Stop the data migration tasks.
Full data migration
We recommend that you do not manually stop the task during full data migration. Otherwise, the data migrated to the destination database may be incomplete. You can wait until the full data migration task automatically stops.
Incremental data migration
An incremental data migration task does not automatically stop. You must manually stop the task.
NoteWe recommend that you select an appropriate time to manually stop a data migration task. For example, you can stop the task during off-peak hours or before you switch your workloads to the ApsaraDB for MongoDB instance.
Wait until Incremental Data Migration is displayed in the Running progress bar of the data migration task and Undelayed is displayed in Operation Info. Then, stop writing data to the source database for a few minutes. The latency of incremental data migration may be displayed in the progress bar.
After the status of Incremental Data Migration changes to Undelayed again, manually stop the migration tasks for all shards.
Switch your workloads to the destination ApsaraDB for MongoDB instance.