This topic describes how to migrate data from a TiDB database to a PolarDB for MySQL cluster by using Data Transmission Service (DTS).
Prerequisites
The destination PolarDB for MySQL cluster is created. The available storage space of the cluster is larger than the total size of data in the source TiDB database. For more information, see Purchase an Enterprise Edition cluster and Purchase a subscription cluster.
If you want to migrate incremental data from the TiDB database, you must make preparations to collect the incremental data. For more information, see the Preparations (optional) section of this topic.
Preparations (optional)
You can use one of the following methods to collect incremental data from the TiDB database:
Use TiDB Binlog
The server on which the source database is deployed must be in the same internal network as the servers on which Pump, Drainer, and the Kafka cluster are deployed. This minimizes the impact of network latency on incremental data migration.
Prepare a Kafka cluster or instance by using one of the following methods.
Deploy a self-managed Kafka cluster. For more information, visit the Apache Kafka official website.
WarningWe recommend that you set the
message.max.bytes
andreplica.fetch.max.bytes
parameters for the Kafka broker and thefetch.message.max.bytes
parameter for the Kafka consumer to greater values. This ensures that the Kafka cluster can receive a larger amount of binary log data from the TiDB database. For more information, see CONFIGURATION.Create an ApsaraMQ for Kafka instance. For more information, see Overview.
NoteThe ApsaraMQ for Kafka instance must be deployed in the same virtual private cloud (VPC) as the source database server. This ensures reliable data transmission and minimizes the impact of network latency on incremental data migration.
Create a topic in the self-managed Kafka cluster or the ApsaraMQ for Kafka instance.
ImportantTo ensure that incremental data can be replicated to the partition whose ID is 0, make sure that the topic contains only one partition.
Deploy Pump and Drainer. For more information, see TiDB Binlog Cluster Deployment.
Modify the configuration file of Drainer and specify a Kafka cluster to receive data from Drainer. For more information, see Binlog Consumer Client User Guide.
NoteMake sure that the server on which the TiDB database is deployed can connect to the Kafka cluster.
Add the CIDR blocks of DTS servers to a whitelist of the TiDB database. For more information, see Add the CIDR blocks of DTS servers.
Use TiCDC
Prepare a Kafka cluster or instance by using one of the following methods.
Deploy a self-managed Kafka cluster. For more information, visit the Apache Kafka official website.
WarningWe recommend that you set the
message.max.bytes
andreplica.fetch.max.bytes
parameters for the Kafka broker and thefetch.message.max.bytes
parameter for the Kafka consumer to greater values. This ensures that the Kafka cluster can receive a larger amount of binary log data from the TiDB database. For more information, see CONFIGURATION.Create an ApsaraMQ for Kafka instance. For more information, see Overview.
NoteThe ApsaraMQ for Kafka instance must be deployed in the same virtual private cloud (VPC) as the source database server. This ensures reliable data transmission and minimizes the impact of network latency on incremental data migration.
Create a topic in the self-managed Kafka cluster or the ApsaraMQ for Kafka instance.
ImportantTo ensure that incremental data can be replicated to the partition whose ID is 0, make sure that the topic contains only one partition.
Install TiCDC. For more information, see Deploy and Maintain TiCDC.
NoteWe recommend that you use TiUP to add a new TiCDC node or scale out the existing TiCDC node in the TiDB cluster.
Replicate the incremental data in the source TiDB database to Kafka. For more information, see Replicate Data to Kafka.
NoteMake sure that the server on which the TiDB database is deployed can connect to the Kafka cluster.
We recommend that you use
tiup cdc cli changefeed create \
in the first command line.
Usage notes
Category | Description |
Limits on the source database |
|
Other limits |
|
Billing
Migration type | Instance configuration fee | Internet traffic fee |
Schema migration and full data migration | Free of charge. | When the Access Method parameter of the destination database is set to Public IP Address, you are charged for Internet traffic. For more information, see Billing overview. |
Incremental data migration | Charged. For more information, see Billing overview. |
SQL operations that support incremental migration
Operation type | SQL statement |
DML | INSERT, UPDATE, and DELETE |
DDL | CREATE TABLE, DROP TABLE, RENAME TABLE, TRUNCATE TABLE, ADD COLUMN, and DROP COLUMN |
Permissions required for database accounts
Database | Required permissions | References |
TiDB database | The SELECT permission on objects to migrate and the SHOW VIEW permission | |
PolarDB for MySQL cluster | The read and write permissions on the destination database |
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
Log on to the DTS console.
In the left-side navigation pane, click Data Migration.
In the upper-left corner of the page, select the region in which the data migration instance resides.
DMS console
NoteThe 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.
Log on to the DMS console.
In the top navigation bar, move the pointer over
.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.
Optional. Click New Configuration Page in the upper-right corner of the page.
NoteSkip this step if the Back to Previous Version button is displayed in the upper-right corner of the page.
Specific parameters in the new and previous versions of the configuration page may be different. We recommend that you use the new version of the configuration page.
Configure the source and destination databases. The following table describes the parameters.
Section
Parameter
Description
N/A
Task Name
The name of the DTS task. DTS automatically generates a task name. 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 a DMS database instance.
The 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 use an existing instance, you must configure the database information below.
NoteIn the DMS console, you can click Add DMS Database Instance to register a database with DMS. For more information, see Register an Alibaba Cloud database instance and Register a database hosted on a third-party cloud service or a self-managed database.
In the DTS console, you can register a database with DTS on the Database Connections page or the new configuration page. For more information, see Manage database connections.
Database Type
The type of the source database. Select TiDB.
Access Method
The access method of the source database. Select an access method based on the deployment location of the TiDB database. In this example, select Self-managed Database on ECS.
NoteIf you set this parameter to other values, you must prepare the environment that is required for the self-managed database before data migration. For more information, see Preparation overview.
Instance Region
The region in which the TiDB database resides.
ECS Instance ID
The ID of the ECS instance that hosts the TiDB database.
Port Number
The service port number of the source TiDB database. Default value: 4000.
Database Account
The account of the TiDB database. For more information about the permissions 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.
Migrate Incremental Data
Specifies whether to migrate the incremental data of the TiDB database. Configure this parameter based on your business requirements.
NoteIf you want to migrate incremental data from the TiDB database, select Yes and enter the Kafka cluster information. For more information, see the Kafka cluster section of this topic.
Destination Database
Select a DMS database instance.
The 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 use an existing instance, you must configure the database information below.
NoteIn the DMS console, you can click Add DMS Database Instance to register a database with DMS. For more information, see Register an Alibaba Cloud database instance and Register a database hosted on a third-party cloud service or a self-managed database.
In the DTS console, you can register a database with DTS on the Database Connections page or the new configuration page. For more information, see Manage database connections.
Database Type
The type of the destination database. Select PolarDB for MySQL.
Access Method
The access method of the destination database. Select Alibaba Cloud Instance.
Instance Region
The region in which the destination PolarDB for MySQL cluster resides.
Replicate Data Across Alibaba Cloud Accounts
In this example, a database instance of the current Alibaba Cloud account is used. Select No.
PolarDB Cluster ID
The ID of the destination PolarDB for MySQL cluster.
Database Account
The database account of the destination PolarDB for MySQL cluster. For information about the permissions that are required for the account, see the Permissions required for database accounts section of this topic.
Database Password
The password that is used to access the database instance.
Encryption
Specifies whether to encrypt the connection to the source PolarDB for MySQL cluster. You can set this parameter based on your business requirements. For more information about the SSL encryption feature, see Configure SSL encryption.
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 topic.
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.
On the Configure Objects page, configure the objects that you want to migrate.
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 Schema Migration, make sure a database and a table are created in the destination database to receive data and the object name mapping feature is enabled in Selected Objects.
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 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, 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 to add the objects to the Selected Objects section.
NoteYou can select tables 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.
NoteTo specify WHERE conditions to filter data, right-click a table in the Selected Objects section. In the dialog box that appears, specify the conditions. For more information, see Specify filter conditions.
If you use the object name mapping feature to rename an object, other objects that are dependent on the object may fail to be migrated.
Click Next: Advanced Settings to configure advanced settings.
Parameter
Description
Select the engine type of the destination database
The engine type of the destination database. Select an engine type based on your business requirements. Valid values:
InnoDB: the default storage engine.
X-Engine: an online transaction processing (OLTP) database storage engine.
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.
NoteIf you specify different retry time ranges for multiple data migration tasks that share the same source or destination database, the value that is specified later takes precedence.
When DTS retries a connection, you are charged for the DTS instance. We recommend that you specify the retry time range based on your business requirements. You can also release the DTS instance at the earliest opportunity after the source database and destination instance are released.
Retry Time for Other Issues
The retry time range for other issues. For example, if DDL or DML operations fail to be performed after the data migration task is started, DTS immediately retries the operations within the retry time range. Valid values: 1 to 1440. Unit: minutes. Default value: 10. We recommend that you set the parameter to a value greater than 10. If the failed operations are successfully performed within the specified retry time range, DTS resumes the data migration task. Otherwise, the data migration task fails.
ImportantThe value of the Retry Time for Other Issues parameter must be smaller than the value of the Retry Time for Failed Connections parameter.
Enable Throttling for Full Data Migration
Specifies whether to enable throttling for full data migration. During full data migration, DTS uses the read and write resources of the source and destination databases. This may increase the loads of the database servers. You can enable throttling for full data migration based on your business requirements. To configure throttling, you must configure the Queries per second (QPS) to the source database, RPS of Full Data Migration, and Data migration speed for full migration (MB/s) parameters. This reduces the loads of the destination database server.
NoteYou can configure this parameter only if you select Full Data Migration for the Migration Types parameter.
Enable Throttling for Incremental Data Migration
Specifies whether to enable throttling for incremental data migration. To configure throttling, you must configure the RPS of Incremental Data Migration and Data migration speed for incremental migration (MB/s) parameters. This reduces the loads of the destination database server.
NoteYou can configure this parameter only if you select Incremental Data Migration for the Migration Types parameter.
Environment Tag
The environment tag that is used to identify the DTS instance. You can select an environment tag based on your business requirements. In this example, you do not need to configure this parameter.
Configure ETL
Specifies whether to enable the extract, transform, and load (ETL) feature. For more information, see What is ETL? Valid values:
Yes: configures the ETL feature. You can enter data processing statements in the code editor. For more information, see Configure ETL in a data migration or data synchronization task.
No: does not configure the ETL feature.
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.
Click Next Step: Data Verification to configure the data verification task.
For more information about how to use the data verification feature, see Configure a data verification task.
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.
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.
Purchase a data migration instance.
On the Purchase Instance page, configure the Instance Class parameter for the data migration instance. The following table describes the parameters.
Section
Parameter
Description
New Instance Class
Resource Group
The resource group to which the data migration instance belongs. Default value: default resource group. For more information, see What is Resource Management?
Instance Class
DTS provides instance classes that vary in the migration speed. You can select an instance class based on your business scenario. For more information, see Instance classes of data migration instances.
Read and agree to Data Transmission Service (Pay-as-you-go) Service Terms by selecting the check box.
Click Buy and Start. In the message that appears, click OK.
You can view the progress of the task on the Data Migration page.
Kafka cluster
Parameter | Description |
Kafka Cluster Type | The type of the Kafka cluster. Configure this parameter based on the deployment location of the Kafka cluster. In this example, select Self-managed Database on ECS. Note If you select Express Connect, VPN Gateway, or Smart Access Gateway, you must also select a VPC from the Connected VPC drop-down list and specify Domain Name or IP. |
Kafka Data Source Component | Select Use the default binlog format of the TiDB database. or Use the TiCDC Canal-JSON format. based on the preparations you made. |
ECS Instance ID | The ID of the ECS instance to which the Kafka cluster belongs. |
Port Number | The service port of the Kafka cluster. |
Kafka Cluster Account | The username and password of the Kafka cluster. If authentication is not enabled for the Kafka cluster, you do not need to configure this parameter. |
Kafka Cluster Password | |
Kafka Version | The Kafka cluster version. Note If the Kafka cluster version is 1.0 or later, select 1.0. |
Encryption | Specifies whether to encrypt the connection to the Kafka cluster. Select Non-encrypted or SCRAM-SHA-256 based on your business and security requirements. |
Topic | The topic to which the incremental data belongs. |