Migrate data from MySQL to Doris - Data Transmission Service

Data Transmission Service (DTS) supports migrating data from a MySQL database, such as a self-managed MySQL database or an RDS for MySQL instance, to a Doris database for big data analytics. This topic describes how to migrate data from an RDS for MySQL instance (the source database) to a Doris database deployed on an ECS instance (the destination database).

Preparations

Create a destination Doris database. Ensure that the available storage space of this database is larger than the storage space used by the source RDS for MySQL instance.

Note

For information about the supported versions of the source and destination databases, see Overview of data migration scenarios.

Usage notes

Type	Description
Source database limits	The server on which the source database is deployed must have sufficient outbound bandwidth. Otherwise, the data migration speed decreases. If you want to migrate incremental data, the following requirements for binary logs must be met: The binary logging feature is enabled. The binlog_format parameter is set to row and the binlog_row_image parameter is set to full. Otherwise, error messages are returned during the precheck and the data migration task fails to be started. Important If the source database is a self-managed MySQL database deployed in a dual-primary cluster, you must set the log_slave_updates parameter to ON. This ensures that DTS can obtain all binary logs. The binary logs of an ApsaraDB RDS for MySQL instance must be stored for at least three days. We recommend that you store the binary logs seven days. The binary logs of a self-managed MySQL database must be stored for at least seven days. 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 configure the retention period of binary logs based on the preceding requirements. Otherwise, the service reliability or performance stated in the Service Level Agreement (SLA) of DTS may not be guaranteed. Note For more information about how to set Retention Period of the binary logs of an ApsaraDB RDS for MySQL instance, see Configure parameters based on which the system automatically deletes the binary log files of an RDS instance. Migration object requirements: The tables to be migrated have PRIMARY KEY or UNIQUE constraints: Make sure all fields must be unique. Otherwise, the destination database may contain duplicate data. The migration objects include tables that have neither a primary key nor a UNIQUE constraint: We recommend that you select Schema Migration for the Migration Types parameter and duplicate for the Engine parameter in the Configurations for Databases, Tables, and Columns step when you configure an instance. Note During schema migration, DTS adds fields to the destination tables. For more information, see Additional columns. If you select tables as the objects to be migrated and you want 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 configure multiple tasks to migrate the tables or configure a task to migrate the entire database. Limits on operations to be performed on the source database: During schema migration and full data migration, do not execute DDL statements to change the schemas of databases or tables. Otherwise, the data migration task fails. If you perform only full data migration, do not write data to the source database during data migration. Otherwise, data inconsistency between the source and destination databases occurs. To ensure data consistency, we recommend that you select schema migration, full data migration, and incremental data migration as the migration types. The data generated by change operation of binary logs, such as data restored from a physical backup or data from a cascade operation, is not recorded and migrated to the destination database when the data migration instance is running. Note If the change data is not recorded and migrated to the destination database, you can migrate full data again on the premise that your business is not affected. If the source database is MySQL database 8.0.23 or later, and the data to be migrated includes invisible columns, the data of the columns cannot be obtained and data loss occurs. Note To make the columns visible, run the `ALTER TABLE <table_name> ALTER COLUMN <column_name> SET VISIBLE;` command. For more information, see Invisible Columns. Tables that do not have primary keys automatically generate invisible primary keys. You need to make the invisible primary keys visible. For more information, see Generated Invisible Primary Keys.
Other limits	You can migrate data only to tables that use the Unique Key or Duplicate Key model in a Doris database. If the destination table uses the Duplicate Key model, duplicate data may exist in the destination database in the following cases. You can deduplicate the data based on the additional columns (_is_deleted, _version, and _record_id). A retry operation occurred in the data migration instance. A restart operation was executed on the data migration instance. Two or more DML operations were performed on the same row of data to be migrated after the data migration instance started. Note When the destination table uses the Duplicate Key model, DTS converts UPDATE or DELETE statements to INSERT statements. You can specify only the `bucket_count` parameter in the Selected Objects section. Note The `bucket_count` parameter value must be a positive integer. Default value: auto. During data migration, do not create clusters in the destination Doris database. Otherwise, the data migration task fails. You can restart the migration instance to resume the failed task. Doris databases support only database and table names that start with a letter. If the name of a database or table to be migrated does not start with a letter, you must use the object name mapping feature to rename it. If the name of an object to be migrated, such as a database, table, or column, contains Chinese characters, you must use the object name mapping feature to rename it, for example, to English. Otherwise, the task may fail. You cannot execute DDL statements to modify multiple columns at a time or modify the same table in succession when you run the migration instance. During data migration, do not add Backend (BE) nodes to the Doris database. Otherwise, the task fails. You can restart the migration instance to resume the failed task. In MySQL, M in the `VARCHAR(M)` data type represents the character length. In a Doris database, N in the `VARCHAR(N)` data type represents the byte length. If you do not use the schema migration feature of DTS, we recommend that you set the length of a VARCHAR field in the Doris database to four times the length of the VARCHAR field in the MySQL database. During full data migration, DTS consumes some read and write resources of the source and destination databases, which may increase the database load. Before you migrate data, evaluate the performance of the source and destination databases. We recommend that you migrate data during off-peak hours, for example, when the CPU load of the source and destination databases is below 30%. Full data migration involves concurrent INSERT operations, which cause fragmentation in the tables of the destination database. After full data migration is complete, the storage space that is used by the tables in the destination database is larger than that in the source instance. During data migration, do not use tools such as pt-online-schema-change to perform online DDL operations on the migration objects in the source database. Otherwise, the migration fails. If data from sources other than DTS is written to the destination database during data migration, data inconsistency may occur between the source and destination databases. If the source database is an ApsaraDB RDS for MySQL instance for which the EncDB feature is enabled, full data migration cannot be performed. Note ApsaraDB RDS for MySQL instances that have the Transparent Data Encryption (TDE) feature enabled support schema migration, full data migration, and incremental data migration. If a DTS task fails to run, DTS technical support will try to restore the task within 8 hours. During the restoration, the task may be restarted, and the parameters of the task may be modified. Note Only the parameters of the DTS task may be modified. The parameters of databases are not modified. The parameters that may be modified include but are not limited to the parameters in the "Modify instance parameters" section of the Modify the parameters of a DTS instance topic.
Special cases	If the source database is a self-managed MySQL 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 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 DML operation is performed on the source database for a long time, the migration latency may be inaccurate. If the latency of the data migration task is excessively high, you can perform a DML 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. DTS executes the CREATE DATABASE IF NOT EXISTS `test` statement in the source database as scheduled to move forward the binary log file position. If the source database is an Apsara RDS for MySQL instance, take note of the following limit: In incremental data migration, an ApsaraDB RDS for MySQL instance that does not record transaction logs, such as a read-only ApsaraDB RDS for MySQL V5.6 instance, cannot be used as the source database. DTS executes the CREATE DATABASE IF NOT EXISTS `test` statement in the source database as scheduled to move forward the binary log file position.

Billing

Migration type	Task configuration fee	Data transfer cost
Schema migration and full data migration	Free of charge.	This example is free of charge. Note When the Access Method of the destination database is set to Public IP Address, you are charged for data transfer. 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, DELETE
DDL	ADD COLUMN MODIFY COLUMN CHANGE COLUMN DROP COLUMN, DROP TABLE TRUNCATE TABLE RENAME TABLE Important RENAME TABLE operations may cause data inconsistency between the source and destination databases. For example, if you select a table as the object to be migrated and rename the table during data migration, the data of this table is not migrated to the destination database. To prevent this situation, you can select the database to which this table belongs as the object to be migrated when you configure the data migration task. Make sure that the databases to which the table belongs before and after the RENAME TABLE operation are added to the objects to be migrated.

Permissions required for database accounts

Database	Schema migration	Full migration	Incremental migration
Source RDS for MySQL instance	SELECT permission	SELECT permission	Read and write permissions
Destination Doris database	Database access permissions (Usage_priv) and read and write permissions (Select_priv, Load_priv, Alter_priv, Create_priv, and Drop_priv)

To create a database account and grant permissions:

For an RDS for MySQL instance, see Create an account and Modify account permissions.
For a Doris database, see Authentication and Authorization.

Note

If the source database account that you use is not created and authorized in the RDS for MySQL console, make sure that the account has the REPLICATION CLIENT, REPLICATION SLAVE, SHOW VIEW, and SELECT permissions.

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.

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 MySQL.
	Access Method	Select Alibaba Cloud Instance.
	Instance Region	Select the region where the source RDS for MySQL instance resides.
	Replicate Data Across Alibaba Cloud Accounts	In this example, a database instance of the current Alibaba Cloud account is used. Select No.
	RDS Instance ID	Select the instance ID of the source RDS for MySQL instance.
	Database Account	Enter the database account of the source RDS for MySQL 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.
	Encryption	Specifies whether to encrypt the connection to the database. You can select Non-encrypted or SSL-encrypted based on your business requirements. If you want to set this parameter to SSL-encrypted, you must enable SSL encryption for the ApsaraDB RDS for MySQL instance before you configure the DTS task. For more information, see Use a cloud certificate to enable SSL encryption.
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 Doris.
	Access Method	Select a connection type based on the deployment location of the destination database. This example uses Self-managed Database on ECS. Note If you connect to a self-managed database using other connection types, you must perform additional preparations. For more information, see Preparations.
	Instance Region	Select the region where the destination Doris database resides.
	ECS Instance ID	Select the ID of the ECS instance where the destination Doris database resides. Note If the destination Doris database is deployed on multiple ECS instances, for example, if BE or FE nodes are deployed on other ECS instances, you must manually add the IP address CIDR blocks of the DTS service to the security rules of each corresponding ECS instance.
	Port Number	Enter the service port of the destination Doris database. The default port is 9030.
	Database Account	Enter the database account of the destination Doris database. For information about the required permissions, see Permissions required for database accounts.
	Database Password	The password that is used to access the database instance.

In the lower part of the page, click Test Connectivity and Proceed, and then click Test Connectivity in the CIDR Blocks of DTS Servers dialog box that appears.
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 the CIDR blocks of DTS servers.

Configure the objects to be migrated.

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

Configuration	Description
Migration Types	To perform only a full data migration, select both Schema Migration and Full Data Migration. To perform zero-downtime migration, select Schema Migration, Full Data Migration, and Incremental Data Migration. Important When migrating data from MySQL to Doris, data types are converted. If you do not select Schema Migration, you must create tables that use the Unique Key or Duplicate Key model with the appropriate schemas in the destination Doris database beforehand. For more information, see Data type mappings, Additional columns, and Primary Key Model. If you do not select Incremental Data Migration, do not write new data to the source instance during data migration to ensure data consistency.
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 to add the objects to the Selected Objects section. Note You can select databases or tables as migration objects.
Selected Objects	To change a table name to be used in the destination project, right-click the table in the Selected Objects section. For more information, see Map object names. If you select Schema Migration for the Migration Types parameter, you can select only tables as the objects to be migrated and the `bucket_count` parameter must be set. Right-click a table to be migrated in the Selected Objects section, select Yes for the Enable Parameter Settings parameter in the Parameter Settings section that appears, specify Value based on your business requirements, and click OK. Note To select the SQL operations performed on a specific database or table, right-click the object in the Selected Objects section. In the dialog box that appears, select the SQL operations that you want to migrate. For more information, see the SQL operations that support incremental migration section of this topic. To 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.

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 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 You 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. 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 as needed. This example does not require 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.

Optional. In the lower part of the page, click Next: Configure Database and Table Fields. In the dialog box that appears, specify Primary Key Column, Distribution Key, and Engine for the tables that you want to migrate.
Note
- This step is available only if you select Schema Migration for the Migration Types parameter. You can set the Definition Status parameter to All and modify the database and table fields.
- You can select multiple columns for the Primary Key Column parameter from the drop-down list. One or more columns specified for the Primary Key Column parameter can be selected for the Distribution Key parameter.
- If the table does not have primary keys or UNIQUE constraints, select duplicate for the Engine parameter. Otherwise, the data migration task may fail or data loss may occur.

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 an 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.

Data type mappings

Category	Data type in MySQL	Data type in Doris
Numeric	TINYINT	TINYINT
	TINYINT UNSIGNED	SMALLINT
	SMALLINT	SMALLINT
	SMALLINT UNSIGNED	INT
	MEDIUMINT	INT
	MEDIUMINT UNSIGNED	BIGINT
	INT	INT
	INT UNSIGNED	BIGINT
	BIGINT	BIGINT
	BIGINT UNSIGNED	LARGEINT
	BIT(M)	INT
	Decimal	Decimal Note ZEROFILL is not supported.
	Numeric	Decimal
	Float	Float
	Double	DOUBLE
	BOOL BOOLEAN	BOOLEAN
DATE AND TIME	DATE	DATEV2
	DATETIME[(fsp)]	DATETIMEV2
	Timestamp[(fsp)]	DATETIMEV2
	Time[(fsp)]	VARCHAR
	YEAR[(4)]	INT
STRING	CHAR VARCHAR	VARCHAR Important To avoid data loss, data of the CHAR and VARCHAR(n) types is converted to VARCHAR(4*n) after the data is migrated to the destination Doris database. If you do not specify the data length, the default value VARCHAR(65533) is used. If the data length exceeds 65533, the data is converted to the STRING type after it is migrated to the destination Doris database.
	BINARY VARBINARY	STRING
	TINYTEXT TEXT MEDIUMTEXT LONGTEXT	STRING
	TINYBLOB BLOB MEDIUMBOLB LONGBLOB	STRING
	ENUM	STRING
	SET	STRING
	JSON	STRING

Additional columns

Note

The following table provides additional columns that are automatically created by DTS or you manually add in the destination tables in the Duplicate key model.

Column	Type	Default value	Description
_is_deleted	Int	0	Specify whether the data is deleted. Insert: The data record is inserted. Default value: 0. Update: The data record is updated. Default value: 0. Delete: The data record is deleted. Default value: 1.
_version	Bigint	0	Full data migration: Default value: 0. Incremental data migration: The timestamp (seconds) of the source binary log file.
_record_id	Bigint	0	Full data migration: Default value: 0. Incremental data migration: The unique ID of the incremental log entry. Note The ID auto-increments for each new log entry.

Preparations

Usage notes

Billing

SQL operations that support incremental migration

Permissions required for database accounts

Procedure

DTS console

DMS console

Data type mappings

Additional columns