Migrate data from a MongoDB instance without a sharding key to a MongoDB sharded cluster instance - Data Transmission Service

Alibaba Cloud Data Transmission Service (DTS) allows you to migrate data from a source MongoDB instance without a sharding key to a MongoDB instance that is deployed in a sharded cluster architecture. You can specify the default values of the sharding keys in the destination MongoDB instance. This topic describes how to migrate data from an ApsaraDB for MongoDB replica set instance to an ApsaraDB for MongoDB sharded cluster instance by using DTS.

Prerequisites

The destination ApsaraDB for MongoDB sharded cluster instance is created. For more information, see Create a sharded cluster instance.
Note
- If the source ApsaraDB for MongoDB instance is deployed in a sharded cluster architecture, make sure that endpoints are assigned to the shards in the source ApsaraDB for MongoDB instance and the shards share the same account and password. For more information about how to apply for an endpoint, see Apply for an endpoint for a shard or Configserver node.
- For 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 the data in the source ApsaraDB for MongoDB instance. This is a recommended prerequisite.
The databases and collections to be sharded in the destination ApsaraDB for MongoDB instance are created, and sharding is configured based on your business requirements. For more information, see Configure sharding to maximize the performance of shards.
Note
After you configure sharding for a sharded cluster instance, the migrated data will be distributed among different shards. This maximizes the performance of the sharded cluster.

Limits

Category	Description
Limits on the source database	Bandwidth requirements: The server on which the source database is deployed must have sufficient outbound bandwidth. Otherwise, the data migration speed decreases. The collections to be migrated must have PRIMARY KEY or UNIQUE constraints, and all fields must be unique. Otherwise, the destination database may contain duplicate data records. If you select collections as the objects to be migrated and you need to modify the collections in the destination database, such as renaming collections, you can migrate up to 1,000 collections in a single data migration task. If you run a task to migrate more than 1,000 collections, a request error occurs. In this case, we recommend that you configure multiple tasks to migrate the collections in batches or configure a task to migrate the entire database. If you need to migrate incremental data, the destination ApsaraDB for MongoDB instance must meet the following requirements for operation logs: The operation logging feature is enabled for the destination ApsaraDB for MongoDB instance. Otherwise, error messages are returned during the precheck and the data migration task cannot be started. If you perform only incremental data migration, the operation logs of the source database must be retained for at least 24 hours. If you perform both full data synchronization and incremental data migration, the operation logs of the source database must be retained for at least seven days. Otherwise, DTS may fail to obtain the operation logs, which causes the task to fail, or even data inconsistency and data loss. After full data migration is complete, you can set the retention period to more than 24 hours. Make sure that you set the retention period of operation logs based on the preceding requirements. Otherwise, the Service Level Agreement (SLA) of DTS does not guarantee service reliability or performance. Limits on operations to be performed on the source database: During the schema migration and full data migration stages of a data migration task, do not change the schemas of databases or collections. Otherwise, the data migration task fails. If you perform only full data migration, do not write data to the source instance during the data migration. Otherwise, data inconsistency may occur between the source and destination instances. To ensure data consistency, we recommend that you select schema synchronization, full data synchronization, and incremental data synchronization as the synchronization types.
Other limits	You cannot specify the default values of the sharding keys for the new collections that are added to the source ApsaraDB for MongoDB instance when the data migration is in progress. If the source ApsaraDB for MongoDB instance is not deployed in a sharded cluster architecture and the destination ApsaraDB for MongoDB instance is deployed in a sharded cluster architecture, you must configure the required parameters in the Configure Database and Table Fields step. If the version of the destination ApsaraDB for MongoDB sharded cluster instance is earlier than 4.4, the default values of the sharding keys that you configure in the Configure Database and Table Fields step take effect. DTS adds the default values to the original data before the data is written to the destination ApsaraDB for MongoDB instance. If the version of the destination ApsaraDB for MongoDB sharded cluster instance is 4.4 or later, the default values of the sharding keys that you configure in the Configure Database and Table Fields step do not take effect. By default, DTS writes the original data to the destination ApsaraDB for MongoDB instance. To ensure compatibility, the version of the destination ApsaraDB for MongoDB database must be the same as or later than the version of the source ApsaraDB for MongoDB database. If the version of the destination database is earlier than the version of the source database, database compatibility issues may occur. DTS cannot migrate data from the admin or local database. Transaction information is not retained. When transactions are migrated to the destination database, the transactions are converted into a single record. Before you migrate data, evaluate the impact of data migration on the performance of the source and destination databases. We recommend that you migrate data during off-peak hours. During full data migration, DTS uses the read and write resources of the source and destination databases. This may increase the loads on the database servers. During full data migration, concurrent INSERT operations cause fragmentation in the collections of the destination database. After full data migration is complete, the storage space for collections of the destination database is larger than that of the source database. DTS attempts to resume data migration tasks that failed within the last seven days. Before you switch workloads to the destination instance, you must stop or release the failed tasks. You can also revoke the write permissions from the accounts that are used by DTS to access the destination instance. Otherwise, the data in the source instance overwrites the data in the destination instance after a failed task is resumed. The data is concurrently written to the destination database. Therefore, the storage space occupied in the destination database is 5% to 10% larger than the size of the data in the source database. You must use the `db.$table_name.aggregate([{ $count:"myCount"}])` syntax to query the return value of a count operation on the destination ApsaraDB for MongoDB database. Make sure that the destination ApsaraDB for MongoDB instance does not have the same primary key as that in the source database. The default primary key is _id. Otherwise, data may be lost. If the data in the destination database has the same primary key as the source database, clear the related data in the destination database without interrupting the services of DTS. If the same primary key is _id, you can delete the data in the destination database that has the same _id as the source database.
Special cases	If the source database is a self-managed MongoDB database, take note of the following limits: If you perform a primary/secondary switchover on the source database when the data migration task is running, the task fails. DTS calculates the migration latency based on the timestamp of the latest migrated data in the destination database and the current timestamp in the source database. If no update operation is performed on the source database for a long time, the migration latency may be inaccurate. If the latency of the migration task is high, you can perform an update operation on the source database to update the latency. 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	Task configuration fee	Data transfer cost
Schema migration and full data migration	Free of charge.	Charged only when data is migrated from Alibaba Cloud over the Internet. In this example, the data is migrated between Alibaba Cloud instances. Therefore, no data transfer costs are charged. For more information, see Billable items.
Incremental data migration	Charged. For more information, see Billing overview.

Migration types

Migration type	Description
Schema migration	DTS migrates the schemas of 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, collections, and indexes.
Incremental data migration	After full data migration is complete, DTS migrates incremental data from the source ApsaraDB for MongoDB instance to the destination ApsaraDB for MongoDB instance. Note DTS migrates incremental data generated by the following operations: CREATE DATABASE, CREATE COLLECTION, and CREATE INDEX DROP DATABASE, DROP COLLECTION, and DROP INDEX RENAME COLLECTION

Permissions required for database accounts

Database	Schema migration	Full data migration	Incremental data migration
Source ApsaraDB for MongoDB instance	The read permissions on the source database.		The read permissions 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 and the config 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.
1. Log on to the Data Management (DMS) console.
2. In the top navigation bar, click DTS.
3. In the left-side navigation pane, choose DTS (DTS) > Data Migration.
Note
- 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.
From the drop-down list next to Data Migration Tasks, select the region in which the data migration instance resides.
Note If 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 Task wizard, configure the source and destination databases.

Section	Parameter	Description
N/A	Task Name	The name of the task. DTS automatically assigns a name to the task. We recommend that you specify a descriptive name that makes it easy 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 select 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. 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. In this example, No is selected.
	Architecture	The architecture in which the source instance is deployed. In this example, Replica Set is selected. Replica Set: You can deploy multiple types of nodes on a replica set instance to achieve 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 shards. For more information, see Sharded cluster instances. Note If you select Sharded Cluster as the value of the Architecture parameter, you must also 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 is admin.
	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 of the database account.
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 select 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 instance is deployed. In this example, Sharded Cluster is selected.
	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 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 of the database account.

In the lower part of the page, click Test Connectivity and Proceed.
If the source or destination database is an Alibaba Cloud database instance, such as an ApsaraDB RDS for MySQL or ApsaraDB for MongoDB instance, DTS automatically adds the CIDR blocks of DTS servers to the IP address whitelist of the instance. If the source or destination database is a self-managed database hosted on an Elastic Compute Service (ECS) instance, DTS automatically adds the CIDR blocks of DTS servers to the security group rules of the ECS instance, and you must make sure that the ECS instance can access the database. If the self-managed database is hosted on multiple ECS instances, you must manually add the CIDR blocks of DTS servers to the security group rules of each ECS instance. If the source or destination database is a self-managed database that is deployed in a data center or provided by a third-party cloud service provider, you must manually add the CIDR blocks of DTS servers to the IP address whitelist of the database to allow DTS to access the database. For more information, see the "CIDR blocks of DTS servers" section of the Add the CIDR blocks of DTS servers to the security settings of on-premises databases topic.
Warning
If the public CIDR blocks of DTS servers are automatically or manually added to the IP address 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 account and password, limiting the ports that are exposed, authenticating API calls, regularly checking the IP address whitelist or ECS security group rules and forbidding unauthorized CIDR blocks, and connecting the database 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. Note If 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 collections that have the same names as collections in the source database. If the source and destination databases do not contain collections that have identical 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 collections that have identical 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 the following potential risks: DTS does not migrate data records that have the same primary key values as data records in the destination database. Data may fail to be initialized, only specific columns are migrated, or the data migration task fails.
Capitalization of Object Names in Destination Instance	The capitalization of database names, table names, and column 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 in 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 and click the icon to add the objects to the Selected Objects section. Note You can select databases or collections as the objects to be migrated.
Selected Objects	To specify the database to which the data is migrated in the destination ApsaraDB for MongoDB sharded cluster instance, perform the following operations: Right-click a database in the Selected Objects section. In the Edit Schema dialog box, enter the name of the database to which the data is migrated in the destination ApsaraDB for MongoDB sharded cluster instance in the Schema Name field. For more information, see Map object names. To specify the collection to which the data is migrated in the destination ApsaraDB for MongoDB sharded cluster instance, perform the following operations: Right-click a collection in the Selected Objects section. In the Edit Table Name dialog box, enter the name of the collection to which the data is migrated in the destination ApsaraDB for MongoDB sharded cluster instance in the Table Name field. Important You can select a collection to receive data only if you select collections as the objects to be migrated. Note To specify conditions to filter data, right-click a table in the Selected Objects section. In the dialog box that appears, specify the conditions. You can specify conditions to filter data during the full data migration stage of a data migration task. You cannot specify WHERE conditions to filter data during the incremental data migration stage of a data migration task. For more information, see Use SQL conditions to filter data. If you use the object name mapping feature to rename the database or collection to which the data is migrated, other objects that are dependent on the database or collection may fail to be migrated.

Click Next: Advanced Settings to configure advanced settings.

Data Verification Settings
For more information about how to configure the data verification feature, see Enable data verification.

Advanced Settings

Parameter	Description
Select the dedicated cluster used to schedule the task	By default, DTS schedules the data migration task to the shared cluster if you do not specify a dedicated cluster. You can also purchase and specify a dedicated cluster of the required specifications to run the data migration task. 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 will receive notifications. Valid values: No: does not configure alerting. Yes: configures alerting. If you select Yes, you must also specify the alert threshold and alert contacts. For more information, see Configure monitoring and alerting.
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. Note If 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 your earliest opportunity after the source and destination instances are released.
The wait time before a retry when other issues occur in the source and destination databases.	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. Important The value of the The wait time before a retry when other issues occur in the source and destination databases 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. Note This parameter is displayed only when Full Data Migration is selected as Migration Types.
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. Note This parameter is displayed only when Incremental Data Migration is selected as Migration Types.
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, no environment tag is selected.
Configure ETL	Specifies whether to configure 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.

Click Next: Configure Database and Table Fields to specify the default values of the sharding keys.
1. Find the destination collection that you want to configure and click Set Default Value in the Actions column.
  Note
  If the value of the Number of Shard Keys parameter of a collection is 0, the collection does not have a sharding key. You can skip this step.
2. Configure the Shard key default value type parameter.
  Note
  You can select string or int as the value of the Shard key default value type parameter.
3. Configure the Default Value parameter.
  Important
  - The Default Value parameter that you configure takes effect only if the version of the destination ApsaraDB for MongoDB sharded cluster instance is earlier than 4.4.
  - You must specify the default value of each sharding key for the collections to be migrated. Otherwise, an alert is triggered during the Precheck and the data migration task may fail.
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.
Note
- Before 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 troubleshoot the issues based on the error message, you can run a precheck again.
- If an alert is triggered for an item during the precheck:
  If the 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 the 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?
New Instance Class	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 to start the data migration task. You can view the progress of the task in the task list.