Migrate data from a PolarDB-X 2.0 instance to a DataHub project using DTS - Data Transmission Service

This topic describes how to use Data Transmission Service (DTS) to migrate data from a PolarDB-X 2.0 instance to a DataHub project.

Prerequisites

A source PolarDB-X 2.0 instance is created. For more information, see Create an instance.
DataHub is activated, and a project is created to receive the migrated data. For more information, see Getting Started (Synchronization Example) and Manage projects.

Precautions

Category	Description
Source database limits	Bandwidth requirements: The server to which the source database belongs must have sufficient outbound bandwidth. Otherwise, the data migration speed is affected. The source database does not support read-only instances of Enterprise Edition PolarDB-X 2.0. The tables 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 tables as the objects to be migrated and you need to modify the tables in the destination database, such as renaming tables or columns, you can migrate up to 1,000 tables in a single data migration task. If you run a task to migrate more than 1,000 tables, a request error occurs. In this case, we recommend that you split the tables to be migrated, configure multiple tasks to migrate the tables, or configure a task to migrate the entire database. If you want to migrate incremental data, make sure that the following requirements are met: The binary logging feature is enabled. The value of the binlog_row_image parameter is set to full. Otherwise, error messages are returned during precheck and the data migration task cannot be started. If you perform only incremental data migration, the binary logs of the source database must be stored for more than 24 hours. If you perform both full data migration and incremental data migration, the binary logs of the source database must be stored for at least seven days. After full data migration is complete, you can set the retention period to more than 24 hours. Otherwise, DTS may fail to obtain the binary logs and the task may fail. In exceptional circumstances, data inconsistency or loss may occur. Make sure that you set the retention period of binary logs in accordance with the preceding requirements. Otherwise, the SLA of DTS does not guarantee service reliability and performance. Limits on operations in the source database: During schema migration and full data migration, do not perform DDL operations to change the schemas of databases or tables. Otherwise, the data migration task fails. During full and incremental migration, DTS temporarily disables constraint checks and foreign key cascade operations at the session level. If cascade update or delete operations occur in the source database when the task is running, data inconsistency may occur. If you want to change the network type of the PolarDB-X 2.0 instance during data migration, you must also modify the network connection settings of the data migration task. If you perform only full data migration, do not write data to the source database during data migration. Otherwise, data will be inconsistent between the source and destination databases. To ensure data consistency, we recommend that you select schema migration, full data migration, and incremental data migration as the migration types. The data migration instance does not support the TABLEGROUP and the database or schema that contains Locality attribute. Migration of tables whose names are reserved words, such as `select`, is not supported.
Other limits	Only table-level migration is supported. The maximum length of a single String field in the destination DataHub project is 2 MB. Before you migrate data, evaluate the performance of the source and destination databases. We recommend that you migrate data during off-peak hours. During full data migration, DTS consumes read and write resources of the source and destination databases. This may increase the database load. DTS attempts to resume a failed migration task within seven days. Before you switch your workloads to the destination instance, end or release the task. You can also run the `revoke` command to revoke the write permissions from the database account that DTS uses to access the destination instance. This prevents the source data from overwriting the data in the destination instance after the task is automatically resumed. If an instance fails, DTS helpdesk will try to recover the instance within 8 hours. During the recovery process, operations such as restarting the instance and adjusting parameters may be performed. Note When parameters are adjusted, only the parameters of the DTS instance are modified. The parameters of the database are not modified. The parameters that may be modified include but are not limited to those described in Modify instance parameters.
Other notes	DTS periodically updates the `dts_health_check`.`ha_health_check` table in the source database to advance the binary log offset.

Billing

Migration type	Link configuration fee	Data transfer cost
Schema migration	Free of charge.	Not charged in this example.
Incremental data migration	Charged. For more information, see Billing overview.	Not charged in this example.

Migration types

Schema migration
DTS migrates the schemas of the selected objects from the source database to the destination database.
Incremental data migration
After full data migration is complete, DTS migrates incremental data from the source database to the destination database. Incremental data migration allows data to be migrated smoothly without interrupting the services of self-managed applications during data migration.

SQL operations that can be incrementally migrated

Operation type	SQL statement
DML	INSERT, UPDATE, and DELETE
DDL	ADD COLUMN

Permissions required for database accounts

Database	Schema migration	Incremental migration
PolarDB-X 2.0 instance	SELECT permission	REPLICATION SLAVE, REPLICATION CLIENT, and SELECT permissions on the objects to migrate. Note For more information about how to grant permissions, see Account permissions required for data synchronization.

Data type mappings

For more information, see Data type mappings for initial schema synchronization.

Procedure

Use one of the following methods to go to the Data Migration page and select the region in which the data migration instance resides.
DTS console
1. Log on to the DTS console.
2. In the left-side navigation pane, click Data Migration.
3. In the upper-left corner of the page, select the region in which the data migration instance resides.
DMS console
Note
The actual operation 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.
1. Log on to the DMS console.
2. In the top navigation bar, move the pointer over Data + AI > DTS (DTS) > Data Migration.
3. From the drop-down list to the right of Data Migration Tasks, select the region in which the data synchronization instance resides.
Click Create Task to go to the task configuration page.

Configure the source and destination databases. The following table describes the parameters.

Warning

After you select the source and destination instances, read the Limits section at the top of the page. This helps you successfully create and run the migration task.

Category	Configuration	Description
None	Task Name	The name of the DTS task. DTS automatically generates a task name. We recommend that you specify an informative name that makes it easy to identify the task. You do not need to specify a unique task name.
Source Database	Select Existing Connection	If you use a database instance that is registered with DTS, select the instance from the drop-down list. DTS automatically populates the following database parameters for the instance. For more information, see Manage database connections. Note In the DMS console, you can select the database instance from the Select a DMS database instance drop-down list. If you fail to register the instance with DTS, or you do not need to use the instance that is registered with DTS, you must configure the following database information.
	Database Type	Select PolarDB-X 2.0.
	Access Method	Select Cloud Instance.
	Instance Region	Select the region where the source PolarDB-X 2.0 instance resides.
	Cross-account	In this example, data is migrated within the same Alibaba Cloud account. Select No.
	Instance ID	Select the ID of the source PolarDB-X 2.0 instance.
	Database Account	Enter the database account of the source PolarDB-X 2.0 instance. For information about the required permissions, see Permissions required for database accounts.
	Database Password	The password that is used to access the database instance.
Destination Database	Select Existing Connection	If you use a database instance that is registered with DTS, select the instance from the drop-down list. DTS automatically populates the following database parameters for the instance. For more information, see Manage database connections. Note In the DMS console, you can select the database instance from the Select a DMS database instance drop-down list. If you fail to register the instance with DTS, or you do not need to use the instance that is registered with DTS, you must configure the following database information.
	Database Type	Select DataHub.
	Access Method	Select Cloud Instance.
	Instance Region	Select the region where the destination DataHub project resides.
	Project	Select the ID of the destination DataHub project.

In the lower part of the page, click Test Connectivity and Proceed.
Note
Make 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 DTS server IP addresses to a whitelist.

Configure the objects to be migrated.

On the Configure Objects page, configure the objects that you want to migrate.

Configuration	Description
Migration Types	When you migrate data from PolarDB-X 2.0 to DataHub, only Schema Migration and Incremental Migration are supported. Select the migration types based on your requirements. Note If you select Schema Migration, foreign keys in the source database are also migrated to the destination database. If you do not select Incremental Migration, do not write new data to the source instance during data migration to ensure data consistency.
Naming Rules of Additional Columns	When DTS migrates data to DataHub, it adds additional columns to the destination table. The data migration fails if the names of the additional columns conflict with the names of existing columns in the destination table. Select New Rule or Old Rule based on your requirements. Warning Before you select a rule for additional columns, evaluate whether the names of the additional columns will conflict with the names of existing columns in the destination table. For more information about the rules and definitions of additional columns, see Names and definitions of additional columns.
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. Note If 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. Warning If 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, 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 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 and add the objects to the Selected Objects section. Note You can select objects at the database, table, or column level. If you select only tables as migration objects, other objects such as views, triggers, and stored procedures are not migrated to the destination database.
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. Note If you use the object name mapping feature, other objects that depend on the mapped object may fail to migrate. To set a WHERE condition to filter data, right-click the table that you want to migrate in the Selected Objects box and set the filter condition in the dialog box that appears. For more information about how to set the condition, see Set filter conditions. To select the SQL operations to migrate at the database or table level, right-click the migration object in the Selected Objects box and select the required SQL operations in the dialog box that appears.

Click Next: Advanced Settings to configure advanced settings.

Configuration	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.
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 1,440. 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 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. Important The 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 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 You can configure this parameter only if you select Incremental Data Migration for the Migration Types parameter.
Whether to delete SQL operations on heartbeat tables of forward and reverse tasks	Specifies whether to write SQL operations on heartbeat tables to the source database while the DTS instance is running. Valid values: Yes: does not write SQL operations on heartbeat tables. In this case, a latency of the DTS instance may be displayed. No: writes SQL operations on heartbeat tables. In this case, features such as physical backup and cloning of the source database may be affected.
Environment Tag	You can select an environment tag to identify the instance based on your requirements. In this example, you do not need to select a tag.
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 the Configure monitoring and alerting when you create a DTS task section of the Configure monitoring and alerting topic.

Save the task settings and run a precheck.
- To view the parameters to be specified when you call the relevant API operation to configure the DTS task, move the pointer over Next: Save Task Settings and Precheck and click Preview OpenAPI parameters.
- If you do not need to view or have viewed the parameters, click Next: Save Task Settings and Precheck in the lower part of the page.
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 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.

Purchase the instance.

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?
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 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.
Note
- If a data migration task cannot be used to migrate incremental data, the task automatically stops. The Completed is displayed in the Status section.
- If a data migration task can be used to migrate incremental data, the task does not automatically stop. The incremental data migration task never stops or completes. The Running is displayed in the Status section.