This topic describes how to use the data transmission service to migrate data from a TiDB database to a MySQL tenant of OceanBase Database.
A data migration project remaining in an inactive state for a long time may fail to be resumed depending on the retention period of incremental logs. Inactive states include Failed, Paused, and Completed. The data transmission service automatically releases data migration projects that remain in an inactive state for more than 7 days to recycle resources. We recommend that you configure alerting for projects and handle project exceptions in a timely manner.
Background
The data transmission service allows you to create a project to seamlessly migrate the existing business data and incremental data from a TiDB database to a MySQL tenant of OceanBase Database through schema migration, full migration, and incremental synchronization.
TiDB is an integrated distributed database that supports hybrid transactional and analytical processing (HTAP). You must deploy a TiCDC cluster and a Kafka cluster to synchronize incremental data from a TiDB database to a MySQL tenant of OceanBase Database.
TiCDC is an incremental data synchronization tool for TiDB and provides high availability by using a placement driver (PD) cluster, which is the scheduling module of the TiDB cluster and usually consists of three PD nodes. TiKV Server is a TiKV node in the TiDB cluster. It sends data changes in change logs to the TiCDC cluster. TiCDC runs multiple TiCDC processes to obtain and process data from TiKV nodes, and then synchronizes the data to the Kafka cluster. The Kafka cluster saves the incremental logs of the TiDB database that are converted by TiCDC. During incremental data synchronization, the data transmission service obtains the corresponding data from the Kafka cluster and migrates the data to the MySQL tenant of OceanBase Database in real time.
If you create a TiDB data source without binding it to a Kafka data source, you cannot perform incremental synchronization.
Prerequisites
The data transmission service has the privilege to access cloud resources. For more information, see Grant privileges to roles for data transmission.
You have created dedicated database users for data migration in the source TiDB database and destination MySQL tenant of OceanBase Database, and granted corresponding privileges to the users. For more information, see Create a database user.
Limitations
Limitations on the source database
Do not perform DDL operations that modify database or table schemas during schema migration or full data migration. Otherwise, the data migration project may be interrupted.
Only TiDB 4.x and 5.x are supported.
The data transmission service does not support triggers in the destination database. If triggers exist in the destination database, the data migration may fail.
The data transmission service does not support the migration of tables without primary keys and data with spaces from a TiDB database to a MySQL tenant of OceanBase Database.
Data source identifiers and user accounts must be globally unique in the data transmission system.
The data transmission service supports the migration of an object only when the following conditions are met: the database name, table name, and column name of the object are ASCII-encoded without special characters. The special characters are line breaks, spaces, and the following characters: . | " ' ` ( ) = ; / & \.
The data transmission service supports only the TiCDC Open Protocol. If you use an unsupported protocol, a null pointer error is returned.
Considerations
If the source contains foreign keys with the same name, an error occurs during schema migration. In this case, you can rename the foreign keys to resume the project.
If the UTF-8 character set is used in the source, we recommend that you use a compatible character set, such as UTF-8 or UTF-16, in the destination to avoid garbled characters.
Do not write data to the topic synchronously used by TiCDC. Otherwise, a null pointer error is returned.
Check whether the migration precision of the data transmission service for columns of data types such as DECIMAL, FLOAT, and DOUBLE is as expected. If the precision of a destination field type is lower than the precision of the corresponding source field type, the value with a higher precision may be truncated. This may result in data inconsistency between the source and destination fields.
If you modify a unique index in the destination, you must restart the data migration project to avoid data inconsistency.
If the clocks between nodes or between the client and the server are out of synchronization, the latency may be inaccurate during incremental synchronization or reverse incremental migration.
For example, if the clock is earlier than the standard time, the latency can be negative. If the clock is later than the standard time, the latency can be positive.
Take note of the following considerations if you want to aggregate multiple tables:
We recommend that you configure the mappings between the source and destination databases by importing objects or specifying matching rules.
We recommend that you manually create schemas at the destination. If you create schemas at the destination by using the data transmission service, skip the failed objects in the schema migration step.
A difference between the source and destination table schemas may result in data consistency. Some known scenarios are described as follows:
When you manually create a table schema in the destination, if the data type of any column is not supported by the data transmission service, implicit data type conversion may occur in the destination, which causes inconsistent column types between the source and destination databases.
If the length of a column at the destination is shorter than that at the source database, the data of this column may be automatically truncated, which causes data inconsistency between the source and destination databases.
If you have selected only Incremental Synchronization when you created the data migration project, the data transmission service requires that the local incremental logs of the source database be retained for more than 48 hours.
If you have selected Full Migration and Incremental Synchronization when you created the data migration project, the data transmission service requires that the local incremental logs of the source database be retained for at least 7 days. If the data transmission service cannot obtain incremental logs, the data migration project may fail or even the data between the source and destination databases may be inconsistent after migration.
Supported source and destination instances
In the following table, OB_MySQL stands for the MySQL tenant of OceanBase Database.
Source | Destination |
TiDB (self-managed database in a VPC) | OB_MySQL (OceanBase cluster instance) |
TiDB (self-managed database with a public IP address) | OB_MySQL (OceanBase cluster instance) |
Data type mappings
TiDB database | MySQL tenant of OceanBase Database |
INTEGER | INTEGER |
TINYINT | TINYINT |
MEDIUMINT | MEDIUMINT |
BIGINT | BIGINT |
SMALLINT | SMALLINT |
DECIMAL | DECIMAL |
NUMERIC | NUMERIC |
FLOAT | FLOAT |
REAL | REAL |
DOUBLE PRECISION | DOUBLE PRECISION |
BIT | BIT |
CHAR | CHAR |
VARCHAR | VARCHAR |
BINARY | BINARY |
VARBINARY | VARBINARY |
BLOB | BLOB |
TEXT | TEXT |
ENUM | ENUM |
SET | SET |
DATE | DATE |
DATETIME | DATETIME |
TIMESTAMP | TIMESTAMP |
TIME | TIME |
YEAR | YEAR |
Procedure
Log on to the ApsaraDB for OceanBase console and purchase a data migration project.
For more information, see Purchase a data migration project.
Choose Data Transmission > Data Migration. On the page that appears, click Configuration for the data migration project.
If you want to reference the configurations of an existing project, click Reference Configuration. For more information, see Reference and clear the configuration of a data migration project.
On the Select Source and Destination page, configure the related parameters.
Parameter
Description
Migration Project Name
We recommend that you set it to a combination of digits and letters. It must not contain any spaces and cannot exceed 64 characters in length.
Tag (Optional)
Click the field and select a target tag from the drop-down list. You can also click Manage Tags to create, modify, and delete tags. For more information, see Use tags to manage data migration projects.
Source
If you have created a TiDB data source, select it from the drop-down list. If not, click New Data Source in the drop-down list to create one in the dialog box on the right side. For more information, see Create a TiDB data source.
Destination
If you have created a data source for the MySQL tenant of OceanBase Database, select it from the drop-down list. If not, click New Data Source in the drop-down list to create one in the dialog box on the right side. For more information about the parameters, see Create an OceanBase data source.
ImportantFor the MySQL tenant of OceanBase Database at the destination, Instance Type must be set to OceanBase Cluster Instance.
Click Next. In the dialog box that appears, click OK.
Note that this project supports only tables and views with a primary key or a non-null unique index. Other tables and views are automatically filtered out.
On the Select Migration Type page, specify migration types for the current data migration project.
Options available for Migration Type are Schema Migration, Full Migration, Incremental Synchronization, Full Verification, and Reverse Incremental Migration.
Migration type
Description
Schema migration
After a schema migration task is started, the data transmission service migrates the definitions of database objects (such as tables, indexes, constraints, comments, and views) from the source database to the destination database and automatically filters out temporary tables.
Full migration
After a full migration task is started, the data transmission service migrates existing data of tables in the source database to corresponding tables in the destination database. If you select Full Migration, we recommend that you use the
ANALYZE
statement to collect the statistics of the TiDB database before data migration.Incremental synchronization
After an incremental synchronization task is started, the data transmission service synchronizes changed data (data that is added, modified, or removed) from the source database to corresponding tables in the destination database.
DML Synchronization is supported for Incremental Synchronization. You can select operations as needed. For more information, see Configure DDL/DML synchronization. If you create a TiDB data source without binding it to a Kafka data source, you cannot select Incremental Synchronization.
Full verification
After the full migration and incremental synchronization tasks are completed, the data transmission service automatically initiates a full verification task to verify the tables in the source and destination databases.
If you select Full Verification, we recommend that you collect the statistics of the TiDB database and the MySQL tenant of OceanBase Database before full verification.
If you select Incremental Synchronization but do not select all DML statements in the DML Synchronization section, you cannot select Full Verification.
Reverse incremental migration
Data changes made in the destination database after the business database switchover are synchronized to the source database in real time through reverse incremental migration.
Generally, incremental synchronization configurations are reused for reverse incremental migration. You can also customize the configurations for reverse incremental migration as needed.
Click Next. On the Select Migration Objects page, specify the migration objects for the data migration project.
You can select Specify Objects or Match Rules to specify the migration objects.
ImportantThe names of tables to be migrated, as well as the names of columns in the tables, must not contain Chinese characters.
If the database or table name contains a double dollar sign ($$), you cannot create the migration project.
If you select Specify Objects, select the objects to be migrated on the left and click > to add them to the list on the right. You can select tables and views of one or more databases as the migration objects.
The data transmission service allows you to import objects from text files, rename destination objects, and remove a single object or all objects.
NoteWhen you select Match Rules to specify migration objects, object renaming is implemented based on the syntax of the specified matching rules. In the operation area, you can only set filtering conditions. For more information, see Configure matching rules.
Operation
Description
Import objects
In the list on the right, click Import Objects in the upper-right corner.
In the dialog box that appears, click OK.
ImportantThis operation will overwrite previous selections. Proceed with caution.
In the Import Objects dialog box, import the objects to be migrated.
You can import CSV files to rename databases or tables and set row filtering conditions. For more information, see Download and import the settings of migration objects.
Click Validate.
After you import the migration objects, check their validity. Column field mapping is not supported at present.
After the validation succeeds, click OK.
Rename an object
The data transmission service allows you to rename migration objects. For more information, see Rename a database table.
Configure settings
The data transmission service allows you to filter rows by using
WHERE
conditions. For more information, see Use SQL conditions to filter data.You can also view column information of the migration objects in the View Columns section.
Remove one or all objects
The data transmission service allows you to remove a single object or all migration objects that are added to the right-side list during data mapping.
Remove a single migration object
In the list on the right, move the pointer over the object that you want to remove, and click Remove to remove the migration object.
Remove all migration objects
In the list on the right, click Remove All in the upper-right corner. In the dialog box that appears, click OK to remove all migration objects.
Select Match Rules. For more information, see Configure matching rules.
Click Next. On the Migration Options page, configure the parameters.
Full migration
The following table describes the parameters for full migration, which are displayed only if you have selected Full Data Migration on the Select Migration Type page.
Parameter
Description
Read Concurrency Configuration
The concurrency for reading data from the source during full migration. The maximum value is 512. A high read concurrency may incur excessive stress on the source, affecting the business.
Write Concurrency Configuration
The concurrency for writing data to the destination during full migration. The maximum value is 512. A high write concurrency may incur excessive stress on the destination, affecting the business.
Full Data Migration Rate Limit
You can choose whether to limit the full migration rate as needed. If you choose to limit the full migration rate, you must specify the records per second (RPS) and bytes per second (BPS). The RPS specifies the maximum number of data rows migrated to the destination per second during full migration, and the BPS specifies the maximum amount of data in bytes migrated to the destination per second during full migration.
NoteThe RPS and BPS values specified here are only for throttling. The actual full migration performance is subject to factors such as the settings of the source and destination and the instance specifications.
Processing Strategy When Destination Table Has Records
Valid values: Ignore and Stop Migration.
If you select Ignore, when the data to be inserted conflicts with existing data of a destination table, the data transmission service logs the conflicting data while retaining the existing data.
ImportantIf you select Ignore, data is pulled in IN mode during full verification. In this case, verification is inapplicable if the destination contains data that does not exist in the source, and the verification performance is downgraded.
If you select Stop Migration and a destination table contains records, an error prompting migration unsupported is reported during full migration. In this case, you must process the data in the destination table and then continue with the migration.
ImportantIf you click Resume in the dialog box prompting the error, the data transmission service ignores this error and continues to migrate data. Proceed with caution.
Whether to Allow Post-indexing
Specifies whether to create indexes after the full migration is completed. Post-indexing can shorten the time required for full migration. For more information about the considerations on post-indexing, see the description below.
ImportantThis parameter is displayed only if both Schema Migration and Full Data Migration are selected on the Select Migration Type page.
Only non-unique key indexes can be created after the migration is completed.
If the
Duplicate key name
error occurs in the destination MySQL tenant of OceanBase Database during indexing, the data transmission service ignores the error and determines that the index is created, without creating an index again.
If post-indexing is allowed, we recommend that you adjust the parameters based on the hardware conditions of your OceanBase database and the current business traffic.
If you use OceanBase Database V4.x, adjust the following parameters of the sys tenant and business tenants by using a CLI client.
Modify the parameters of the sys tenant
// parallel_servers_target specifies the queue condition for parallel queries on each server. // To maximize performance, we recommend that you set this parameter to a value greater than, for example, 1.5 times, the number of physical CPU cores. In addition, make sure that the value does not exceed 64, to prevent database kernels from contending for locks. set global parallel_servers_target = 64;
Modify the parameters of a user tenant
// Specify the limit on the file memory buffer size. alter system set _temporary_file_io_area_size = '10' tenant = 'xxx'; // Disable throttling in OceanBase Database V4.x. alter system set sys_bkgd_net_percentage = 100;
If you use OceanBase Database V3.x, modify the following parameters of the sys tenant by using a CLI client.
// parallel_servers_target specifies the queue condition for parallel queries on each server. // To maximize performance, we recommend that you set this parameter to a value greater than, for example, 1.5 times, the number of physical CPU cores. In addition, make sure that the value does not exceed 64, to prevent database kernels from contending for locks. set global parallel_servers_target = 64; // data_copy_concurrency specifies the maximum number of concurrent data migration and replication tasks allowed in the system. alter system set data_copy_concurrency = 200;
Incremental synchronization
The following table describes the parameters for incremental synchronization, which are displayed only if you have selected Incremental Synchronization on the Select Migration Type page.
Parameter
Description
Write Concurrency Configuration
The concurrency for writing data to the destination during incremental synchronization. The maximum value is 512. A high write concurrency may incur excessive stress on the destination, affecting the business.
Incremental Synchronization Rate Limit
You can choose whether to limit the incremental synchronization rate as needed. If you choose to limit the incremental synchronization rate, you must specify the RPS and BPS. The RPS specifies the maximum number of data rows synchronized to the destination per second during incremental synchronization, and the BPS specifies the maximum amount of data in bytes synchronized to the destination per second during incremental synchronization.
NoteThe RPS and BPS specified here are only for throttling. The actual incremental synchronization performance is subject to factors such as the settings of the source and destination and the instance specifications.
Incremental Synchronization Start Timestamp
If you have set the migration type to Full Data Migration, this parameter is not displayed.
If you have selected Incremental Synchronization but not Full Data Migration, specify a point in time after which the data is to be synchronized. The default value is the current system time. For more information, see Set an incremental synchronization timestamp.
Reverse incremental migration
The following table describes the parameters for reverse incremental migration, which are displayed only if you have selected Reverse Increment on the Select Migration Type page. By default, incremental synchronization configurations are reused for reverse incremental migration.
You can choose not to reuse the incremental synchronization configurations and configure reverse incremental migration as needed.
Parameter
Description
Write Concurrency Configuration
The concurrency for writing data to the source during reverse incremental migration. The maximum value is 512. A high concurrency may incur excessive stress on the source, thereby affecting the business.
Incremental Synchronization Rate Limit
You can choose whether to limit the incremental synchronization rate as needed. If you choose to limit the reverse incremental migration rate, you must specify the RPS and BPS. The RPS specifies the maximum number of data rows synchronized to the source per second during reverse incremental migration, and the BPS specifies the maximum amount of data in bytes synchronized to the source per second during reverse incremental migration.
NoteThe RPS and BPS specified here are only for throttling. The actual reverse incremental migration performance is subject to factors such as the settings of the source and destination and the instance specifications.
Incremental Synchronization Start Timestamp
By default, the forward switchover start timestamp (if any) prevails. This parameter cannot be modified.
Advanced migration configuration
This section is displayed only if the destination is a MySQL tenant of OceanBase Database V4.3.0 or later and you have selected Schema Migration on the Select Migration Type page.
This parameter specifies the storage type for destination table objects during schema migration or incremental synchronization. The storage types supported for destination table objects are Default, Row storage, Column storage, and Hybrid columnar storage. For more information, see default_table_store_format.
NoteThe value Default means that other parameters are automatically set based on the parameter configurations of the destination. For table objects in schema migration or new table objects in incremental DDL synchronization, the schemas are subject to the specified storage type.
Click Precheck to start a precheck on the data migration project.
During the precheck, the data transmission service checks the read and write privileges of the database users and the network connections of the databases. The data migration project can be started only after it passes all check items. If an error is returned during the precheck, you can perform the following operations:
Identify and troubleshoot the problem and then perform the precheck again.
Click Skip in the Actions column of the failed precheck item. In the dialog box that prompts the consequences of the operation, click OK.
After the precheck succeeds, click Start Project.
If you do not need to start the project now, click Save. After that, you can only manually start the project or start it in a batch operation on the Migration Projects page. For more information about batch operations, see Perform batch operations on data migration projects.
The data transmission service allows you to modify the migration objects when a migration project is running. For more information, see View and modify migration objects. After the data migration project is started, it will be executed based on the selected migration types. For more information, see View migration details.