Migrate OceanBase to ApsaraDB RDS for MySQL-Data Transmission Service(DTS)-阿里云帮助中心

Prerequisites

The source OceanBase database must be a DTS-supported version.
- If the source database is ApsaraDB for OceanBase, DTS supports only cluster instances, not tenant instances.
- If the source database is a self-hosted OceanBase database, DTS supports only Community Edition 4.X.
Create a target ApsaraDB RDS for MySQL instance with storage space larger than the data size of the source OceanBase database. For more information, see Create an ApsaraDB RDS for MySQL instance.

Limitations

Note

During schema migration, DTS migrates foreign keys from the source database to the destination database.
During full data migration and incremental migration, DTS temporarily disables constraint checks and cascading foreign key operations at the session level. If cascading update or delete operations occur in the source database while the task is running, data inconsistency can occur.

Type	Description
Source database limitations	If the source database is an ApsaraDB for OceanBase instance: Manually configure an IP whitelist to allow DTS to access the instance. For more information, see Configure whitelist groups and Add the IP addresses of DTS servers to the whitelist. For incremental migration, you must enable binlog for the source database and retain the local binlogs for at least three days. For more information, see Enable the binlog service and Manage binlog. If the source database is a self-managed OceanBase database: For incremental migration, you must install oblogproxy (an incremental log proxy service) on the server where the OceanBase database is deployed and configure the system tenant. For more information, see Install and deploy oblogproxy. Bandwidth requirement: The server where the source database is deployed must have sufficient egress bandwidth. Otherwise, the data migration speed will decrease. The tables you are migrating must have a primary key or a unique constraint, and the columns in the constraint must contain only unique values. Otherwise, duplicate data may occur in the destination database. If you select tables as the objects to be migrated and need to edit them, for example, by using object name mapping for column names, a single migration task supports a maximum of 1,000 tables. If this limit is exceeded, an error is reported when you submit the task. In this case, split the tables into multiple batches and create separate tasks, or configure a single task to migrate the entire database. Limitations on source database operations: During schema migration and full data migration, do not run DDL statements to modify the schema of databases or tables. Otherwise, the data migration task will fail. If you perform only full data migration, do not write new data to the source instance during the migration. Otherwise, the source and destination databases will become inconsistent. To ensure real-time data consistency, we recommend that you select schema migration, full data migration, and incremental migration as the migration types. You can migrate data of the GEOMETRY type only by using full data migration. Incremental migration is not supported for this data type.
Other limitations	If the name of the database to be migrated does not comply with the naming conventions of ApsaraDB RDS for MySQL, you need to create a database in ApsaraDB RDS for MySQL before you configure the migration task. Then, use the object name mapping feature in the Configure Objects and Advanced Settings step. For more information about the naming conventions and creation methods for ApsaraDB RDS for MySQL databases, see Manage Databases. If your data includes four-byte characters—such as rare Chinese characters or emojis—the destination database and table must use the utf8mb4 charset. Note If you use DTS to migrate schemas, set the instance-level parameter `character_set_server` to utf8mb4 in the destination database. Ensure that the source and destination tables do not contain hidden columns. Otherwise, the DTS instance may fail or data may be lost. Before you migrate data, evaluate the performance of the source and destination databases. Perform data migration during off-peak hours. During full data migration, DTS consumes read and write resources on both the source and destination databases, increasing their workloads. After full data migration, the destination database's tablespace is typically larger than that of the source's. Verify that the migration precision for FLOAT and DOUBLE columns meets your business requirements. DTS reads values from these columns by using the `ROUND(COLUMN,PRECISION)` function. If you do not specify a precision, DTS migrates FLOAT columns with a precision of 38 digits and DOUBLE columns with a precision of 308 digits. DTS attempts to resume a failed migration task within seven days. Before you switch your workloads to the destination instance, you must stop or release the task, or run the `revoke` command to revoke the write permissions from the account that DTS uses to access the destination instance. This prevents the resumed task from overwriting data in the destination instance. If the source database is an ApsaraDB for OceanBase instance and the DTS task includes incremental migration, DTS periodically attempts to run the CREATE DATABASE IF NOT EXISTS `test` statement on the source database to create a `test` database and write heartbeat data to advance the binlog position. If the account that DTS uses to access the source database does not have the required privileges to create databases, and no DML operations are performed on the source database for an extended period, the latency information may be inaccurate. Note If the displayed latency is too high, you can run a DML statement on the source database to update the latency information. If DDL writes fail on the destination database, the DTS task continues running. Check the failed DDL statements in the task logs. For instructions, see View task logs. If you write columns with identical names but different cases into the same table in the destination MySQL database, unexpected results may occur. MySQL column names are case-insensitive. After migration completes—the task status is Status and the status changes to Completed—run `analyze table <table_name>` to confirm all data is written to the destination table. For example, after a high-availability (HA) switchover in the destination MySQL database, data may remain in memory and never reach disk, causing data loss. If a task fails, DTS support staff will attempt to restore it within eight hours. During restoration, they may restart the task or adjust its parameters. Note Only DTS task parameters are modified—not database parameters. Parameters that may be adjusted include those listed in Modify instance parameters.

Billing

Migration type	Configuration fee	Data transfer fee
Schema migration and full data migration	Free.	Free in this example.
Incremental data migration	Charged. For more information, see billing overview.	Free in this example.

Supported SQL operations

Operation type	SQL statement
DML	INSERT, UPDATE, DELETE
DDL	ALTER TABLE, ALTER VIEW CREATE FUNCTION, CREATE INDEX, CREATE PROCEDURE, CREATE TABLE, CREATE VIEW DROP INDEX, DROP TABLE RENAME TABLE Important A RENAME TABLE operation may cause data inconsistency. For example, if you select only one table as the migration object and rename the table in the source instance during migration, the data of this table is not migrated to the destination database. To prevent this issue, select the entire database to which the table belongs as the migration object 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 both included in the migration objects. TRUNCATE TABLE

Database account permission requirements

Database			Schema migration	Full data migration	Incremental data migration
Source database	self-managed OceanBase	User	SELECT permission
	self-managed OceanBase	Tenant	Regular tenant	Regular tenant	Regular tenant Important You must install oblogproxy (an incremental log proxy service) on the self-managed OceanBase database server and configure the sys tenant. For more information, see Install and deploy oblogproxy.
	ApsaraDB for OceanBase	Tenant	Regular tenant	Regular tenant	Regular tenant
	ApsaraDB for OceanBase	Account	SELECT permission	SELECT permission	read and write permissions
Destination database	ApsaraDB RDS for MySQL		read and write permissions

To create database accounts and grant the required permissions, see the following topics:

For a self-managed OceanBase database, see Create a tenant, Create a user, and Grant privileges.
For an ApsaraDB for OceanBase instance, see Create a tenant and Create an account.
For an ApsaraDB RDS for MySQL instance, see Create an account and Modify account permissions.

Procedure

Navigate to the migration task list page for the destination region using one of the following methods.
From the DTS console
1. Log on to the Data Transmission Service (DTS) console.
2. In the navigation pane on the left, click Data Migration.
3. In the upper-left corner of the page, select the region where the migration instance is located.
From the DMS console

Note
The actual operations may vary based on the mode and layout of the DMS console. For more information, see Simple mode console and Customize the layout and style of the DMS console.
1. Log on to the Data Management (DMS) console.
2. In the top menu bar, choose Data + AI > Data Transmission (DTS) > Data Migration.
3. To the right of Data Migration Tasks, select the region where the migration instance is located.
Click Create Task to navigate to the task configuration page.
Optional: In the upper-right corner of the page, click New Configuration Page.
Note
- If you are already on the new configuration page (the button in the upper-right corner is Back to Previous Version), you can skip this step.
- The parameters on the new and old configuration pages are different. We recommend that you use the new configuration page.

Configure the source and destination databases.

OceanBase Database instance

Category	Parameter	Description
N/A	Task Name	DTS automatically generates a task name. We recommend that you specify a descriptive name for easy identification. The name does not need to be unique.
Source Database	Select Existing Connection	To use a database instance that has been added to the system (created or saved), select the desired database instance from the drop-down list. The database information below will be automatically configured. Note In the DMS console, this parameter is named Select a DMS database instance.. If you have not registered the database instance with the system, or do not need to use a registered instance, manually configure the database information below.
	Database Type	Select ApsaraDB OceanBase for MySQL.
	Access Method	Select Alibaba Cloud Instance.
	Instance Region	Select the region of the source OceanBase Database instance.
	Replicate Data Across Alibaba Cloud Accounts	In this example, a database instance under the current Alibaba Cloud account is used. Select No.
	Instance ID	Select the instance ID of the source OceanBase Database instance.
	Tenant ID	Select the tenant ID of the source OceanBase Database instance. Note To learn how to obtain the tenant ID, see Tenant list details.
	Database Account	Enter the database account of the source OceanBase Database instance. To learn about the required permissions, see Database account permissions.
	Database Password	Enter the password for the specified database account.
Destination Database	Select Existing Connection	To use a database instance that has been added to the system (created or saved), select the desired database instance from the drop-down list. The database information below will be automatically configured. Note In the DMS console, this parameter is named Select a DMS database instance.. If you have not registered the database instance with the system, or do not need to use a registered instance, manually configure the database information below.
	Database Type	Select MySQL.
	Access Method	Select Alibaba Cloud Instance.
	Instance Region	Select the region of the destination ApsaraDB RDS for MySQL instance.
	Replicate Data Across Alibaba Cloud Accounts	This example covers migration within the same Alibaba Cloud account. Select No.
	RDS Instance ID	Select the instance ID of the destination ApsaraDB RDS for MySQL instance.
	Database Account	Enter the database account of the destination ApsaraDB RDS for MySQL instance. To learn about the required permissions, see Database account permissions.
	Database Password	Enter the password for the database account.
	Encryption	Select Non-encrypted or SSL-encrypted based on your database requirements. If you set this parameter to SSL-encrypted, you must enable SSL encryption for the RDS for MySQL instance beforehand. For more information, see Quickly enable SSL encryption using a cloud certificate.

Self-managed OceanBase

Category	Parameter	Description
N/A	Task Name	DTS automatically generates a task name. We recommend that you specify a descriptive name for easy identification. The name does not need to be unique.
Source Database	Select Existing Connection	To use a database instance that has been added to the system (created or saved), select the desired database instance from the drop-down list. The database information below will be automatically configured. Note In the DMS console, this parameter is named Select a DMS database instance.. If you have not registered the database instance with the system, or do not need to use a registered instance, manually configure the database information below.
	Database Type	Select ApsaraDB OceanBase for MySQL.
	Access Method	Select an access method based on the deployment location of the source self-managed OceanBase database. This example uses Public IP Address. Note Other access methods require additional preparation. For more information, see Preparation overview. When the source database is a self-managed OceanBase database, see FAQ for issues that you may encounter when you configure Source Database.
	Instance Region	Select the region of the source self-managed OceanBase database.
	Domain Name or IP	Enter the endpoint of the source self-managed OceanBase database.
	Port Number	Enter the connection port for the source database. The default is 2881.
	IP Address in Log Proxy (Domain Name Not Supported)	Enter the IP address of the Log Proxy service for the source database.
	Port in Log Proxy	Enter the listener port of the Log Proxy service for the source database. The default is 2983.
	Database Account	Enter the database account of the source self-managed OceanBase database. To learn about the required permissions, see Database account permissions.
	Database Password	Enter the password for the specified database account.
Destination Database	Select Existing Connection	To use a database instance that has been added to the system (created or saved), select the desired database instance from the drop-down list. The database information below will be automatically configured. Note In the DMS console, this parameter is named Select a DMS database instance.. If you have not registered the database instance with the system, or do not need to use a registered instance, manually configure the database information below.
	Database Type	Select MySQL.
	Access Method	Select Alibaba Cloud Instance.
	Instance Region	Select the region of the destination ApsaraDB RDS for MySQL instance.
	Replicate Data Across Alibaba Cloud Accounts	This example covers migration within the same Alibaba Cloud account. Select No.
	RDS Instance ID	Select the instance ID of the destination ApsaraDB RDS for MySQL instance.
	Database Account	Enter the database account of the destination ApsaraDB RDS for MySQL instance. To learn about the required permissions, see Database account permissions.
	Database Password	Enter the password for the database account.
	Encryption	Select Non-encrypted or SSL-encrypted based on your database requirements. If you set this parameter to SSL-encrypted, you must enable SSL encryption for the RDS for MySQL instance beforehand. For more information, see Quickly enable SSL encryption using a cloud certificate.

Frequently asked questions

If the Log Proxy service is not installed for the OceanBase database, how do I specify the Log Proxy parameters?

Leave the IP Address in Log Proxy (Domain Name Not Supported) and Port in Log Proxy fields empty. Additionally, do not select Incremental Data Migration for Migration Types in the next step. Otherwise, the task will fail.
What if my database's region is not in the Instance Region drop-down list?

You can select the region that is geographically closest to your database.
If the OceanBase database is deployed in a cluster, what should I enter for Domain Name or IP?

Enter the IP address of the OBServer node that you specified when you configured the cluster.
How do I specify the Port Number of the OceanBase database?
- If the OceanBase database is deployed on a single node, you can keep the default value.
- If the OceanBase database is deployed in a cluster, you must enter the SQL port that you specified when you configured the cluster.
How do I specify the Database Account for the OceanBase database?

The Database Account must use the <username>@<tenant_name> format. For example, an account for user dtstest in the dts tenant should be entered as dtstest@dts.

After you complete the configuration, click Test Connectivity and Proceed at the bottom of the page.
Note
- Ensure that the IP address segment of the DTS service is 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.
- If the source or destination database is a self-managed database (the Access Method is not Alibaba Cloud Instance), you must also click Test Connectivity in the CIDR Blocks of DTS Servers dialog box that appears.

Configure the task objects.

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

Parameter	Description
Migration Types	If you only need to perform a full migration, select both Schema Migration and Full Data Migration. To perform a migration with no downtime, select Schema Migration, Full Data Migration, and Incremental Data Migration. Note If you do not select Schema Migration, you must ensure that a database and tables to receive the data exist in the destination database. You can also use the object name mapping feature in the Selected Objects box as needed. If you do not select Incremental Data Migration, do not write new data to the source instance during data migration to ensure data consistency.
Method to Migrate Triggers in Source Database	Select a migration method for triggers. If your migration does not include triggers, you can skip this setting. For more information, see Configure how triggers are synchronized or migrated. Note This setting is available only when you select Schema Migration for Migration Types.
Processing Mode of Conflicting Tables	Precheck and Report Errors: Checks whether tables with the same names exist in the destination database. If no tables with the same names exist, the precheck is passed. If tables with the same names exist, an error is reported during the precheck, and the data migration task does not start. Note If a table in the destination database has the same name but cannot be easily deleted or renamed, you can change the name of the table in the destination database. For more information, see Object name mapping. Ignore Errors and Proceed: Skips the check for tables with the same names. Warning Selecting Ignore Errors and Proceed may cause data inconsistency and business risks. For example: If the table schemas are consistent and a record in the destination database has the same primary key value as a record in the source database: During full migration, DTS keeps the record in the destination database. The record from the source database is not migrated. During incremental migration, DTS does not keep the record in the destination database. The record from the source database overwrites the record in the destination database. If the table schemas are inconsistent, only some columns of data may be migrated, or the migration may fail. Proceed with caution.
Capitalization of Object Names in Destination Instance	You can configure the case sensitivity policy for the names of migrated objects, such as databases, tables, and columns, in the destination instance. By default, DTS default policy is selected. You can also choose to keep the case sensitivity consistent with the default policy of the source or destination database. For more information, see Case sensitivity of object names in the destination database.
Source Objects	In the Source Objects box, click the objects to migrate, and then click to move them to the Selected Objects box. Note The granularity for selecting migration objects is database, table, and column. If you select only tables or columns as migration objects, other objects such as views, triggers, and stored procedures are not migrated to the destination database.
Selected Objects	To change the name of a single migration object in the target instance, right-click the object in the Selected Objects box. For more information, see Map individual schema, table, and column names. To change the names of multiple migration objects in the target instance, click Selected Objects in the upper-right corner of the Batch Edit box. For more information, see Map multiple schema, table, and column names. Note Object name mapping can lead to data inconsistency or cause the migration of dependent objects to fail. For example, if you use column mapping but do not migrate the entire table, or if the table structures are inconsistent, data in columns that are missing from the destination table will be lost. To filter data by using a WHERE clause, right-click a table in the Selected Objects list and specify a filter condition in the dialog box that appears. For more information, see Set Filter Conditions. To select the SQL operations for incremental migration at the database or table level, right-click an object in the Selected Objects list and select the desired SQL operations in the dialog box that appears.

Click Next: Advanced Settings to configure advanced parameters.

Parameter	Description
Dedicated Cluster for Task Scheduling	By default, DTS schedules tasks on a shared cluster. You do not need to select one. If you want more stable tasks, you can purchase a dedicated cluster to run DTS migration tasks.
Retry Time for Failed Connections	After the migration task starts, if the connection to the source or destination database fails, DTS reports an error and immediately begins to retry the connection. The default retry duration is 720 minutes. You can customize the retry time to a value from 10 to 1440 minutes. We recommend that you set the duration to more than 30 minutes. If DTS reconnects to the source and destination databases within the specified duration, the migration task automatically resumes. Otherwise, the task fails. Note For multiple DTS instances that share the same source or destination, the network retry time is determined by the setting of the last created task. Because you are charged for the task during the connection retry period, we recommend that you customize the retry time based on your business needs, or release the DTS instance as soon as possible after the source and destination database instances are released.
Retry Time for Other Issues	After the migration task starts, if a non-connectivity issue, such as a DDL or DML execution exception, occurs in the source or destination database, DTS reports an error and immediately begins to retry the operation. The default retry duration is 10 minutes. You can customize the retry time to a value from 1 to 1440 minutes. We recommend that you set the duration to more than 10 minutes. If the related operations succeed within the specified retry duration, the migration task automatically resumes. Otherwise, the task fails. Important The value of Retry Time for Other Issues must be less than the value of Retry Time for Failed Connections.
Enable Throttling for Full Data Migration	During full migration, DTS consumes read and write resources on the source and destination databases, which may increase the database load. If required, you can enable throttling for the full migration task. You can set Queries per second (QPS) to the source database, RPS of Full Data Migration, and Data migration speed for full migration (MB/s) to reduce the load on the destination database. Note This configuration item is available only if you select Full Data Migration for Migration Types. You can also adjust the full migration speed after the migration instance is running.
Enable Throttling for Incremental Data Migration	If required, you can also choose to set speed limits for the incremental migration task. You can set RPS of Incremental Data Migration and Data migration speed for incremental migration (MB/s) to reduce the load on the destination database. Note This configuration item is available only if you select Incremental Data Migration for Migration Types. You can also adjust the incremental migration speed after the migration instance is running.
Environment Tag	You can select an environment tag to identify the DTS instance. This setting is not required for this example.
Configure ETL	Based on your business needs, select whether to configure the ETL feature to process data. Yes: Configures the ETL feature. You must also enter data processing statements in the text box. No: Does not configure the ETL feature.
Monitoring and Alerting	Select whether to set alerts and receive alert notifications based on your business needs. No: Does not set an alert. Yes: Configure alerts by setting an alert threshold and an alert contact. If a migration fails or the latency exceeds the threshold, the system sends an alert notification.

Save the task and run a precheck.
- To view the parameters for configuring this instance when you call the API operation, move the pointer over the Next: Save Task Settings and Precheck button and click Preview OpenAPI parameters in the bubble that appears.
- If you do not need to view or have finished viewing the API parameters, click Next: Save Task Settings and Precheck at the bottom of the page.
Note
- Before the migration task starts, DTS performs a precheck. The task starts only after it passes the precheck.
- If the precheck fails, click View Details next to the failed check item, fix the issue based on the prompt, and then run the precheck again.
- If a warning is reported during the precheck:
  
  For check items that cannot be ignored, click View Details next to the failed item, fix the issue based on the prompt, and then run the precheck again.
  
  For check items that can be ignored, you can click Confirm Alert Details, Ignore, OK, and Precheck Again to skip the alert item and run the precheck again. If you choose to ignore a warning, it may cause issues such as data inconsistency and pose risks to your business.

Purchase an instance.

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

On the Purchase page, select the link specification for the data migration instance. For more information, see the following table.

Category	Parameter	Description
New Instance Class	Resource Group Settings	Select the resource group to which the instance belongs. The default value is default resource group. For more information, see What is Resource Management?
New Instance Class	Instance Class	DTS provides migration specifications with different performance levels. The link specification affects the migration speed. You can select a specification based on your business scenario. For more information, see Data migration link specifications.

After the configuration is complete, read and select Data Transmission Service (Pay-as-you-go) Service Terms.
Click Buy and Start. In the OK dialog box that appears, click OK.

You can view the progress of the migration task on the Data Migration Tasks list page.
Note
- If the migration task does not include incremental migration, it stops automatically after the full migration is complete. After the task stops, its Status changes to Completed.
- If the migration task includes incremental migration, it does not stop automatically. The incremental migration task continues to run. While the incremental migration task is running, the Status of the task is Running.