Migrate data from an OceanBase database to an ApsaraDB RDS for MySQL instance - Data Transmission Service

Data Transmission Service (DTS) allows you to migrate data from an OceanBase database to an ApsaraDB RDS for MySQL instance. This frees you from database O&M concerns.

Prerequisites

The source OceanBase database is a Community Edition database of V4.X.
The destination ApsaraDB RDS for MySQL instance is created. The available storage space of this instance is larger than the total size of data in the source OceanBase database. For more information, see Create an ApsaraDB RDS for MySQL instance.

Limits

Note

During schema migration, DTS migrates foreign keys from the source database to the destination database.
During full data migration and incremental data migration, DTS temporarily disables the constraint check and cascade operations on foreign keys at the session level. If you perform the cascade and delete operations on the source database during data migration, data inconsistency may occur.

Category	Description
Limits on the source database	If the source database is an ApsaraDB for OceanBase instance, it must be a cluster instance in the China (Shenzhen) or China (Shanghai) region. Tenant instances are not supported. Note You must manually add the CIDR blocks of DTS servers to the IP address whitelist of ApsaraDB for OceanBase to allow DTS to access ApsaraDB for OceanBase. The CIDS blocks to be added are the same as those for databases whose Access Method is Express Connect, VPN Gateway, or Smart Access Gateway. For more information, see Create a whitelist group and the CIDR blocks of DTS servers section of this topic. The server on which the source database is deployed must have sufficient egress bandwidth. Otherwise, the data migration speed decreases. 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 edit 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 in batches 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. Data of the GEOMETRY type can be migrated only by using full data migration. Incremental migration of such data is not supported.
Other limits	If the name of the database to be migrated does not comply with the database naming conventions of ApsaraDB RDS for MySQL, you must create a database in the destination ApsaraDB RDS for MySQL instance before you configure a data migration task. Then, you can use the object name mapping feature to rename the database in the Configure Objects and Advanced Settings step when you configure the data migration task. For more information about how to create an ApsaraDB RDS for MySQL instance and the naming conventions, see Manage databases. Before you migrate data, evaluate the impact of data migration on the performance of the source and destination databases. We recommend that you migrate data during off-peak hours. During full data migration, DTS uses the read and write resources of the source and destination databases. This may increase the loads of the database servers. During full data migration, concurrent INSERT operations cause fragmentation in the tables of the destination database. After full data migration is complete, the size of used tablespace of the destination database is larger than that of the source database. You must make sure that the precision settings for columns of the FLOAT or DOUBLE data type meet your business requirements. DTS uses the `ROUND(COLUMN,PRECISION)` function to retrieve values from columns of the FLOAT or DOUBLE data type. If you do not specify a precision, DTS sets the precision for the FLOAT data type to 38 digits and the precision for the DOUBLE data type to 308 digits. DTS attempts to resume data migration tasks that failed within the last seven days. Before you switch workloads to the destination cluster, you must stop or release the failed tasks. You can also execute the `REVOKE` statement to revoke the write permissions from the accounts that are used by DTS to access the destination database. Otherwise, the data in the source database overwrites the data in the destination database after the data migration task is resumed. If DDL statements fail to be executed in the destination database, the DTS task continues to run. You can view the DDL statements that fail to be executed in task logs. For more information about how to view task logs, see View task logs. If you write column names that differ only in capitalization to the same table in the destination MySQL database, the data migration result may not meet your expectations because the column names in MySQL databases are not case-sensitive. After data migration is complete, we recommend that you run the `analyze table <table name>` command to check whether data is written to the destination table. For example, if a high-availability (HA) switchover is triggered in the source MySQL database, data may be written only to the memory. As a result, data loss occurs.

Billing

Migration type	Task configuration fee	Data transfer fee
Schema migration and full data migration	Free of charge.	Free of charge in this example.
Incremental data migration	Charged. For more information, see Billing overview.	Free of charge in this example.

SQL operations that support incremental migration

Operation type	SQL statement
DML	INSERT, UPDATE, and DELETE
DDL	ALTER TABLE and ALTER VIEW CREATE FUNCTION, CREATE INDEX, CREATE PROCEDURE, CREATE TABLE, and CREATE VIEW DROP INDEX and DROP 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, 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. TRUNCATE TABLE

Permissions required for database accounts

Database type		Schema migration	Full data migration	Incremental data migration
OceanBase	User	The SELECT permission
	Tenant	Regular tenant	Regular tenant	Regular tenant Important You must install oblogproxy on the server that hosts the source OceanBase database and configure the sys tenant. oblogproxy is a proxy service for managing incremental logs. For more information, see Install and deploy oblogproxy by using the installation package.
RDS MySQL		Read and write permissions on the destination database

For more information about how to create a database account and grant permissions to the database account, see the following topics:

OceanBase: Create a tenant, Create a user, and Grant privileges
ApsaraDB RDS for MySQL: Create an account and Modify the permissions of an account

Procedure

Go to the Data Migration Tasks page.
1. Log on to the Data Management (DMS) console.
2. In the top navigation bar, click DTS.
3. In the left-side navigation pane, choose DTS (DTS) > Data Migration.
Note
- Operations may vary based on the mode and layout of the DMS console. For more information, see Simple mode and Customize the layout and style of the DMS console.
- You can also go to the Data Migration Tasks page of the new DTS console.
From the drop-down list next to Data Migration Tasks, select the region in which the data migration instance resides.
Note
If you use the new DTS console, you must select the region in which the data migration instance resides in the upper-left corner.

Click Create Task. On the Create Data Migration Task page, configure the source and destination databases. The following table describes the parameters.

Section	Parameter	Description
N/A	Task Name	The name of the task. DTS automatically assigns a name to the task. We recommend that you specify a descriptive name that makes it easy to identify the task. You do not need to specify a unique task name.
Source Database	Select an existing DMS database instance. (Optional. If you have not registered a DMS database instance, ignore this option and configure database settings in the section below.)	The database instance that you want to use. You can choose whether to 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 select an existing instance, you must configure parameters for the source database.
	Database Type	The type of the source database. Select ApsaraDB OceanBase for MySQL.
	Access Method	The access method of the source database. Select a value based on the deployment location of the source database. In this example, Public IP Address is selected. Note If a self-managed database is used as the source database, 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 source OceanBase database resides.
	IP Address or Domain Name	The endpoint of the source OceanBase database.
	Port Number	The service port of the source OceanBase database. Default value: 2881.
	IP Address in Log Proxy (Domain Name Not Supported)	The IP address of oblogproxy for the source OceanBase database.
	Port in Log Proxy	The listening port of oblogproxy for the source OceanBase database. Default value: 2983.
	Database Account	The account of the source OceanBase database. For more information about the permissions that are required for the account, see the Permissions required for database accounts section of this topic.
	Database Password	The password of the database account.
Destination Database	Select an existing DMS database instance. (Optional. If you have not registered a DMS database instance, ignore this option and configure database settings in the section below.)	The database instance that you want to use. You can choose whether to 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 select an existing instance, you must configure parameters for the source database.
	Database Type	The type of the destination database. Select MySQL.
	Access Method	The access method of the destination database. Select Alibaba Cloud Instance.
	Instance Region	The region where the destination ApsaraDB RDS for MySQL instance resides.
	Replicate Data Across Alibaba Cloud Accounts	Specifies whether to migrate data across Alibaba Cloud accounts. In this example, No is selected.
	RDS Instance ID	The ID of the ApsaraDB RDS for MySQL instance.
	Database Account	The database account of the destination ApsaraDB RDS for MySQL instance. For more information about the permissions that are required for the account, see the Permissions required for database accounts section of this topic.
	Database Password	The password of the database account.
	Encryption	Specifies whether to encrypt the connection to the source database instance. Select Non-encrypted or SSL-encrypted based on your business requirements. If you select SSL-encrypted, you must enable SSL encryption for the ApsaraDB RDS for MySQL instance before you configure the data migration task. For more information, see Configure the SSL encryption feature.

In the lower part of the page, click Test Connectivity and Proceed.
If an IP address whitelist is configured for your self-managed database, you must add the CIDR blocks of DTS servers to the IP address whitelist. Then, 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.
Warning
If 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 and advanced settings. The following table describes the parameters.

Parameter	Description
Migration Types	To perform only full data migration, select Schema Migration and Full Data Migration. To ensure service continuity during data migration, select Schema Migration, Full Data Migration, and Incremental Data Migration. Note If you do not select Incremental Data Migration, we recommend that you do not write data to the source database during data migration. This ensures data consistency between the source and destination databases.
Method to Migrate Triggers in Source Database	The method that is used to migrate triggers from the source database. You can select a migration method based on your business requirements. If no triggers are to be migrated, you do not need to configure this parameter. For more information, see Synchronize or migrate triggers from the source database. Note This parameter is available only if Schema Migration is selected for Migration Types.
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, DTS does not migrate data records that have the same primary keys as data records in the destination database. 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 and click the icon to add the objects to the Selected Objects section. Note You can select columns, tables, or databases as the objects to be migrated. If you select tables or columns as the objects to be migrated, DTS does not migrate other objects, such as views, triggers, or stored procedures, 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 to rename an object, other objects that are dependent on the object may fail to be migrated. For example, if column mapping is used for non-full table migration or if the schemas of the source and destination tables are inconsistent, the data in the columns of the source database that are not contained in the destination database is lost. 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 Set filter conditions. To select the SQL operations that are 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 incrementally migrate. For more information, see the SQL operations that support incremental migration section of this topic.

Click Next: Advanced Settings to configure advanced settings. The following table describes the parameters.

Parameter	Description
Dedicated Cluster for Task Scheduling	By default, DTS schedules the task to a shared cluster. You do not need to configure this parameter. 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.
Set Alerts	Specifies whether to configure alerting for the data migration task. If the task fails or the migration latency exceeds the specified threshold, the alert contacts 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 Configure monitoring and alerting when you create a DTS task.
Retry Time for Failed Connections	The retry time range for failed connections. If the source or destination database fails to be connected after the data migration task is started, DTS immediately retries a connection within the retry time range. Valid values: 10 to 1440. Unit: minutes. Default value: 720. We recommend that you set the parameter to a value greater than 30. If DTS is reconnected to the source and destination databases within the specified retry time range, DTS resumes the data migration task. Otherwise, the data migration task fails. Note If you specify different retry time ranges for multiple data migration tasks that share the same source or destination database, the value that is specified later takes precedence. When DTS retries a connection, you are charged for the DTS instance. We recommend that you specify the retry time range based on your business requirements. You can also release the DTS instance at 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.
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.

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 generated for an item during the precheck, perform the following operations based on the scenario:
  If the alert item cannot be ignored, click View Details next to the failed item and troubleshoot the issues. Then, run a precheck again.
  If the alert item can be ignored, click Confirm Alert Details. In the View Details dialog box, click Ignore. In the message that appears, click OK. Then, click Precheck Again to run a precheck again. If you ignore the alert item, data inconsistency may occur and your business may be exposed to potential risks.
Wait until the success rate becomes 100%. Then, click Next: Purchase Instance.

On the Purchase Instance page, configure the Instance Class parameter for the data migration instance. The following table describes the parameters.

Section	Parameter	Description
New Instance Class	Resource Group Settings	The resource group to which the data migration instance belongs. Default value: default resource group. For more information, see What is Resource Management?
New Instance Class	Instance Class	DTS provides instance classes that vary in the migration speed. You can select an instance class based on your business scenario. For more information, see Specifications of data migration instances.

Read and agree to Data Transmission Service (Pay-as-you-go) Service Terms by selecting the check box.
Click Buy and Start to start the data migration task. You can view the progress of the task in the task list.

FAQ

How do I set oblogproxy-related parameters if oblogproxy is not installed for the source OceanBase database?
Use the default values of IP Address in Log Proxy (Domain Name Not Supported) and Port in Log Proxy. In addition, do not select Incremental Data Migration for Migration Types when you configure the advanced settings. Otherwise, an error is reported.
How do I set the Instance Region parameter if the region of the source OceanBase database is not displayed in the Instance Region drop-down list?
From the Instance Region drop-down list, select a region that is the nearest to the region of the source OceanBase database.
How do I configure the Domain Name or IP parameter if the source OceanBase database is deployed in a cluster?
Set this parameter to the value that you specified for OBServer Node when you created the cluster.
How do I set the Port Number parameter for the source OceanBase database?
- If the source OceanBase database is deployed in standalone mode, use the default value.
- If the source OceanBase database is deployed in a cluster, set this parameter to the value that you specified for SQL Port when you created the cluster.
How do I set the Database Account parameter for the source OceanBase database?
Specify a value in the <Username>@< Tenant name> format for Database Account. For example, the source OceanBase database is created by a user named dtstest in the tenant named dts. In this case, set Database Account to dtstest@dts.