Synchronize ApsaraDB for MongoDB data to Lindorm

Prerequisites

• The source ApsaraDB for MongoDB instance must have either a replica set or a sharded cluster architecture.

  Important

  If the source ApsaraDB for MongoDB instance has a sharded cluster architecture, you must obtain an endpoint for each shard node and verify that all shard nodes use the same account and password. For more information, see Apply for a shard endpoint.

• Create a target Lindorm instance that uses the wide table engine and has more storage space than the source ApsaraDB for MongoDB instance. For more information, see Create an instance.

  Note

  The target instance's storage capacity should be at least 10% larger than the storage space used by the source database.

• Create a wide table in your Lindorm instance based on your business requirements. For instructions, see Connect to and use LindormTable with Lindorm-cli or Connect to LindormTable with Lindorm Shell.

  Note

  • All objects you create must comply with Quotas and limits.

  • If you created the wide table in Lindorm by using Apache HBase, we recommend adding column mappings to the table. For more information, see Example of adding column mappings for a table created by calling the Apache HBase API.

Precautions

Billing

Synchronization types

Database account permissions

Procedure

1. Go to the data synchronization task list page in the destination region. You can do this in one of two ways.

   DTS console

   1. Log on to the DTS console.

   2. In the navigation pane on the left, click Data Synchronization.

   3. In the upper-left corner of the page, select the region where the synchronization instance is located.

   DMS console

   Note

   The actual steps may vary depending on the mode and layout of the DMS console. For more information, see Simple mode console and Customize DMS console layout and style.

   1. Log on to the DMS console.

   2. In the top menu bar, choose Data + AI > DTS (DTS) > Data Synchronization.

   3. To the right of Data Synchronization Tasks, select the region of the synchronization instance.

2. Click Create Task to open the task configuration page.

3. Configure the source and destination databases.

   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	Select the registered database instance with DTS from the drop-down list. The database information below is automatically configured. Note In the DMS console, this configuration item is Select a DMS database instance. If you have not registered the database instance or do not need to use a registered instance, manually configure the database information below.
   	Database Type	Select MongoDB.
   	Access Method	Select Alibaba Cloud Instance.
   	Instance Region	Select the region where the source ApsaraDB for MongoDB instance is located.
   	Replicate Data Across Alibaba Cloud Accounts	This example shows how to synchronize data within the same Alibaba Cloud account. Select No.
   	Architecture	In this example, select Replica Set. Note If the source ApsaraDB for MongoDB instance is a Sharded Cluster, you must also specify the Shard account and Shard password.
   	Migration Method	Select a method for incremental data synchronization based on your requirements. Oplog (Recommended): This option is available if Oplog is enabled for the source database. Note Oplog is enabled by default for self-managed MongoDB databases and ApsaraDB for MongoDB instances. This method offers lower latency for incremental synchronization tasks because logs are retrieved faster. We recommend selecting Oplog. ChangeStream: This option is available if Change Streams are enabled for the source database. Note If the source database is an Amazon DocumentDB (non-elastic cluster) instance, you can select only ChangeStream. If you set Architecture of the source database to Sharded Cluster, you do not need to specify Shard account and Shard password.
   	Instance ID	Select the ID of the source ApsaraDB for MongoDB instance.
   	Authentication Database	Enter the name of the authentication database for the source ApsaraDB for MongoDB instance. The default value is admin.
   	Database Account	Enter the database account for your source ApsaraDB for MongoDB instance. For information about the required permissions, see Permissions required for database accounts.
   	Database Password	Enter the password for the specified 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. Note A 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	Select the registered database instance with DTS from the drop-down list. The database information below is automatically configured. Note In the DMS console, this configuration item is Select a DMS database instance. If you have not registered the database instance or do not need to use a registered instance, manually configure the database information below.
   	Database Type	Select Lindorm.
   	Access Method	Select Alibaba Cloud Instance.
   	Instance Region	Select the region where the destination Lindorm instance is located.
   	Instance ID	Select the ID of the destination Lindorm instance.
   	Database Account	Enter the database account for the destination Lindorm instance. For information about the required permissions, see Permissions required for database accounts.
   	Database Password	Enter the password for the specified database account.

4. After completing the configuration, click Test Connectivity and Proceed at the bottom of the page.

   Note

   • Ensure 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.

5. Configure the task objects.

   1. On the Configure Objects page, specify the objects to synchronize.

      Parameter	Description
      Synchronization Types	By default, Incremental Data Synchronization is selected, which supports only Full Data Synchronization. Schema Synchronization is not supported. After the precheck is complete, DTS initializes the synchronization objects in the destination cluster with data from the source instance. This initial data serves as the baseline for subsequent incremental synchronization.
      Processing Mode of Conflicting Tables	No configuration is required. You can keep the default setting.
      Capitalization of Object Names in Destination Instance	You can configure the case policy for database and collection object names in the destination instance. By default, the DTS default policy is selected. Alternatively, you can match the default policy of the source or destination database. For more information, see Case policy for destination object names.
      Source Objects	In the Source Objects box, click the objects, and then click to move them to the Selected Objects box. Note You can select objects at the collection level.
      Selected Objects	If you used Lindorm SQL to create the wide table in the destination database, you must configure additional columns for synchronization. Unconfigured columns are not synchronized. Edit the database name mapping. In the Selected Objects box, right-click the database that contains the collection that you want to synchronize. Change Schema Name to the name of the destination database in Lindorm. In the displayed dialog box, select the DML operations to be synchronized (insert, update, and delete). In the Additional Columns section, click + New Column to add columns. Then, click OK. Optional: In the Select DML Operations to Be Synchronized section, select the incremental operations that you want to synchronize. Click OK. Edit the table name mapping. In the Selected Objects box, right-click the collection that you want to synchronize. Change Table Name to the name of the destination table in Lindorm. In the Edit Table dialog box, you can also set Filter Conditions. The syntax for ApsaraDB for MongoDB filter conditions is different from the standard SQL WHERE clause. In the Select DML Operations to Be Synchronized section, select insert, update, and delete. In the Additional Columns section, click + New Column to add columns to the destination table for purposes such as metadata management, sorting, or deduplication. After you complete the settings, click OK. Optional: Set filter conditions. For more information, see Set filter conditions. Optional: In the Select DML Operations to Be Synchronized section, select the incremental operations that you want to synchronize. Configure the MongoDB fields to be synchronized. By default, DTS maps the data of the collection to be synchronized and configures an expression in the Parameter Value column. You must check whether the expression meets your requirements and specify information such as the Column Name, Type, Length, and Precision. In the Parameter Value column, view the name of the field in MongoDB within the bson_value() expression. The content enclosed in "" is the field name in MongoDB. For example, if the expression is bson_value("age"), this row corresponds to the age field in MongoDB. Optional: Delete fields that you do not want to synchronize. Note To remove a field that you do not want to synchronize, click the icon in the corresponding row. Configure the fields to synchronize. Perform the following steps based on whether the bson_value() expression meets your requirements. Matching expressions Enter a Column Name. Note This is the name of the destination column in the Lindorm table. If the destination table is created by using SQL, enter the name of the column in the Lindorm table for the Column Name parameter. If the destination table is created by using HBase and you need to use the add column feature, you must add column mappings before you change the column name. For more information, see Example of adding column mappings for an HBase table. Configure the Column Name as follows: If the column is a primary key, enter ROW. If the column is not a primary key, use the format column_family:column_name, such as person:name. Select a data Type for the column. Important Make sure that the data type of the destination table is compatible with the data in the source MongoDB database. Optional: Configure the Length and Precision for the column data. Repeat these steps to map all relevant fields. Non-matching expressions Note For example, fields that have hierarchical (parent-child) structures. In the Actions column, click the icon in the corresponding row. Click + New Column. In the Additional Columns section, click the + New Column button in the upper-right corner. Configure the Column Name, Type, Length, and Precision. In the text box under Parameter Value, enter the bson_value() expression. For more information, see Value assignment examples. Important The value bson_value("_id") must be assigned to the primary key column of the destination table. When you configure the bson_value() expression, you must specify the path down to the lowest-level subfield in the hierarchy. Otherwise, data loss may occur or the task may fail. Repeat these steps to map all relevant fields. Click OK.

   2. Click Next: Advanced Settings.

      Parameter	Description
      Dedicated Cluster for Task Scheduling	By default, DTS uses a shared cluster for tasks, so you do not need to make a selection. For greater task stability, you can purchase a dedicated cluster to run the DTS synchronization task. For more information, see What is a DTS dedicated cluster?.
      Retry Time for Failed Connections	If the connection to the source or destination database fails after the synchronization task starts, 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 1,440 minutes. We recommend a duration of 30 minutes or more. If the connection is restored within this period, the task resumes automatically. Otherwise, the task fails. Note If multiple DTS instances (e.g., Instance A and B) share a source or destination, DTS uses the shortest configured retry duration (e.g., 30 minutes for A, 60 for B, so 30 minutes is used) for all instances. DTS charges for task runtime during connection retries. Set a custom duration based on your business needs, or release the DTS instance promptly after you release the source/destination instances.
      Retry Time for Other Issues	If a non-connection issue (e.g., a DDL or DML execution error) occurs, DTS reports an error and immediately retries the operation. The default retry duration is 10 minutes. You can also customize the retry time to a value from 1 to 1,440 minutes. We recommend a duration of 10 minutes or more. If the related operations succeed within the set retry time, the synchronization task automatically resumes. Otherwise, the task fails. Important The value of Retry Time for Other Issues must be less than that of Retry Time for Failed Connections.
      Enable Throttling for Full Data Synchronization	During full data synchronization, DTS consumes read and write resources from the source and destination databases, which can increase their load. To mitigate pressure on the destination database, you can limit the migration rate by setting Queries per second (QPS) to the source database, RPS of Full Data Migration, and Data migration speed for full migration (MB/s). Note This parameter is available only if Synchronization Types is set to Full Data Synchronization. You can also adjust the rate of full data synchronization when the synchronization instance is running.
      Only one data type for primary key _id in a table of the data to be synchronized	Specify whether the data types of the _id primary key are unique within each collection to be synchronized. Important Select an option based on your actual data. An incorrect selection may lead to data loss. This parameter is available only if Synchronization Types includes Full Data Synchronization. Yes: The data types are unique. During the full synchronization phase, DTS does not scan the data types of the primary keys in the source data. For each collection, DTS synchronizes only the data corresponding to one primary key data type. No: The data types are not unique. During the full synchronization phase, DTS scans the data types of the primary keys in the source data and synchronizes all the data.
      Enable Throttling for Incremental Data Synchronization	You can also limit the incremental synchronization rate to reduce pressure on the destination database by setting RPS of Incremental Data Synchronization and Data synchronization speed for incremental synchronization (MB/s).
      Environment Tag	You can select an environment tag to identify the instance based on your requirements. In this example, no selection is needed.
      Configure ETL	Choose whether to enable the extract, transform, and load (ETL) feature. For more information, see What is ETL? Valid values: Yes: Enables the ETL feature. Enter data processing statements in the code editor. For more information, see Configure ETL in a data migration or data synchronization task. No: Disables the ETL feature. Note If the destination table is created by using HBase, take note of the following: The ETL syntax includes columns to be configured and columns to be excluded. During synchronization, all top-level fields of the MongoDB documents for which ETL is configured are stored in the default column family f of the HBase table. The following example shows how to write all elements except for the two top-level elements _id and name as dynamic columns to the destination table. For more information, see HBase table synchronization example (ETL). script:e_expand_bson_value("*", "_id,name") If you need to use both the new column feature and the ETL feature, make sure that the data in Lindorm is not duplicated. Columns for which neither the new column feature nor the ETL feature is configured are not synchronized to the destination database.
      Monitoring and Alerting	Choose whether to set up alerts. If the synchronization fails or the latency exceeds the specified threshold, DTS sends a notification to the alert contacts. No: No alerts are configured. Yes: Configures alerts. You must also set the alert threshold and alert contact. For more information, see Configure monitoring and alerting during task configuration.

6. Save the task and perform a precheck.

   • To view the parameters for configuring this instance via an API operation, hover over the Next: Save Task Settings and Precheck button and click Preview OpenAPI parameters in the tooltip.

   • If you have finished viewing the API parameters, click Next: Save Task Settings and Precheck at the bottom of the page.

   Note

   • Before a synchronization task starts, DTS performs a precheck. You can start the task only if the precheck passes.

   • If the precheck fails, click View Details next to the failed item, fix the issue as prompted, and then rerun the precheck.

   • If the precheck generates warnings:

     • For non-ignorable warning, click View Details next to the item, fix the issue as prompted, and run the precheck again.

     • For ignorable warnings, you can bypass them by clicking Confirm Alert Details, then Ignore, and then OK. Finally, click Precheck Again to skip the warning and run the precheck again. Ignoring precheck warnings may lead to data inconsistencies and other business risks. Proceed with caution.

7. Purchase the instance.

   1. When the Success Rate reaches 100%, click Next: Purchase Instance.

   2. On the Purchase page, select the billing method and link specifications for the data synchronization instance. For more information, see the following table.

      Category	Parameter	Description
      New Instance Class	Billing Method	Subscription: You pay upfront for a specific duration. This is cost-effective for long-term, continuous tasks. Pay-as-you-go: You are billed hourly for actual usage. This is ideal for short-term or test tasks, as you can release the instance at any time to save costs.
      	Resource Group Settings	The resource group to which the instance belongs. The default is default resource group. For more information, see What is Resource Management?.
      	Instance Class	DTS offers synchronization specifications at different performance levels that affect the synchronization rate. Select a specification based on your business requirements. For more information, see Data synchronization link specifications.
      	Subscription Duration	In subscription mode, select the duration and quantity of the instance. Monthly options range from 1 to 9 months. Yearly options include 1, 2, 3, or 5 years. Note This option appears only when the billing method is Subscription.

   3. Read and select the checkbox for Data Transmission Service (Pay-as-you-go) Service Terms.

   4. Click Buy and Start, and then click OK in the OK dialog box.

      You can monitor the task progress on the data synchronization page.

Add column mappings to an HBase table

This example shows the commands to run in the SQL Shell.

1. Add a column mapping to the HBase table.

   ALTER TABLE test MAP DYNAMIC COLUMN f:_mongo_id_ HSTRING/HINT/..., person:name HSTRING, person:age HINT;

2. Create a secondary index on the HBase table.

   CREATE INDEX idx ON test(f:_mongo_id_);

Example: ETL for HBase tables

{
  "_id" : 0,
  "person" : {
    "name" : "cindy0",
    "age" : 0,
    "student" : true
  }
}

script:e_expand_bson_value("*", "_id")

0: jdbc:lindorm:xxx> select * from mongo_test_dynamic_column limit 3;
+------+------+-------------+----------------------------------------------------------+
| ROW  | COL  | _mongo_id_  |                         person                           |
+------+------+-------------+----------------------------------------------------------+
|      | 0    |             | { "name" : "cindy0", "age" : 0, "student" : true }      |
|      | 1    |             | { "name" : "cindy1", "age" : 1, "student" : false }     |
|      | 2    |             | { "name" : "cindy2", "age" : 2, "student" : true }      |
+------+------+-------------+----------------------------------------------------------+
3 rows selected (0.009 seconds)

Value assignment example

{
  "_id":"62cd344c85c1ea6a2a9f****",
  "person":{
    "name":"neo",
    "age":"26",
    "sex":"male"
  }
}