Synchronize data between MySQL tenants of OceanBase Database - ApsaraDB for OceanBase

This topic describes how to synchronize data between MySQL tenants of OceanBase Database.

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 synchronization in the OceanBase databases and granted corresponding privileges to the users. For more information, see Create a database user.

Limitations

The data transmission service supports the synchronization 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: . | " ' ` ( ) = ; / & \.

Considerations

Clock desynchronization between nodes, or between the computer terminal and the server, can result in inaccurate incremental synchronization latency.

For example, if the clock is ahead of the standard time, it may result in a negative latency. Conversely, if the clock is behind the standard time, it may result in an increased latency.

Supported source and target instance types

Important

The data transmission service supports only the synchronization of tables with unique keys between two MySQL tenants of OceanBase Database.

Source	Destination
OB_MySQL (OceanBase cluster instance)	OB_MySQL (OceanBase cluster instance)
OB_MySQL (OceanBase cluster instance)	OB_MySQL (self-managed database in a VPC)
OB_MySQL (self-managed database in a VPC)	OB_MySQL (OceanBase cluster instance)

Procedure

Log on to the ApsaraDB for OceanBase console and purchase a data synchronization project.
For more information, see Purchase a data synchronization project.
Choose Data Transmission > Data Synchronization. On the page that appears, click Configuration for the data synchronization 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 synchronization project.

On the Select Source and Destination page, configure the parameters.

Parameter	Description
Synchronization 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	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 Manage data synchronization projects by using tags.
Source	If you have created an OceanBase 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 about the parameters, see Create an OceanBase data source. Important When the source is a MySQL tenant of OceanBase Database, the value of Instance Type must not be OceanBase Database Tenant Instance.
Destination	If you have created an OceanBase 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. Important When the destination is a MySQL tenant of OceanBase Database, the value of Instance Type must not be OceanBase Database Tenant Instance.

Click Next. On the Select Synchronization Type page, specify the synchronization type for the current data synchronization project.
Options for the Synchronization Type parameter are Schema Synchronization, Full Synchronization, and Incremental Synchronization. Options for Incremental Synchronization are DML Synchronization and DDL Synchronization. You can select options as needed. For more information, see Configure DDL/DML synchronization.
- Options for DML Synchronization are Insert, Delete, and Update, which are all selected by default.
- ADD COLUMN and MODIFY COLUMN are supported for DDL Synchronization.

Click Next. On the Select Synchronization Objects page, select the objects to be synchronized in the current data synchronization project.

You can select Specify Objects or Match Rules to specify the synchronization objects.

Important

The name of a table to be synchronized, as well as the names of columns in the table, must not contain Chinese characters.
If a database or table name contains a double dollar sign ($$), you cannot create the synchronization project.
After you select synchronization objects by using the Specify Objects option, the DDL operations take effect only for the selected objects, and table creation is not supported.

Select Specify Objects. Then select the objects to be synchronized on the left and click > to add them to the list on the right. You can select tables of one or more databases as the synchronization objects.

The data transmission service allows you to import objects by using text. It also allows you to rename objects, set row filters, and remove a single object or all objects.

Note

When you select Match Rules to specify synchronization 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. Important This operation will overwrite previous selections. Proceed with caution. In the Import Synchronization Objects dialog box, import the objects to be synchronized. 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 synchronization objects. Click Validate. After the validation succeeds, click OK.
Rename an object	The data transmission service allows you to rename synchronization objects. For more information, see Rename a database table.
Configure settings	You can use the `WHERE` clause to filter data by row and view column information of synchronization objects. In the list on the right, move the pointer over the object that you want to set. Click Settings. In the Settings dialog box, you can perform the following operations: In the Row Filters section, specify a standard SQL `WHERE` clause to filter data by row. For more information, see Use SQL conditions to filter data. You can also view column information about synchronization objects in the View Columns section. Click OK.
Remove one or all objects	The data transmission service allows you to remove a single object or all synchronization objects that are added to the right-side list during data mapping. Remove a single synchronization object In the list on the right, move the pointer over the object that you want to remove, and click Remove to remove the synchronization object. Remove all synchronization 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 synchronization objects.

Select Match Rules. For more information, see Configure matching rules.

Click Next. On the Synchronization Options page, configure the parameters.

Full synchronization

The following table describes the parameters for full synchronization, which are displayed only if you have selected Full Synchronization on the Select Synchronization Type page.

Parameter	Description
Read Concurrency Configuration	The concurrency for reading data from the source during full synchronization. The maximum value is 512. A high concurrency may incur excessive stress on the source, thereby affecting the business.
Write Concurrency Configuration	The concurrency for writing data to the destination during full synchronization. The maximum value is 512. A high write concurrency may incur excessive stress on the destination, affecting the business.
Full Synchronization Rate Limit	You can choose whether to limit the full synchronization rate as needed. If you choose to limit the full synchronization rate, you must specify the records per second (RPS) and bytes per second (BPS). The RPS specifies the maximum number of data rows synchronized to the destination per second during full synchronization, and the BPS specifies the maximum amount of data in bytes synchronized to the destination per second during full synchronization. Note The RPS and BPS values specified here are only for throttling. The actual full synchronization 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	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. Important If you select Ignore, data is pulled in IN mode for 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. Important If 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.

Incremental synchronization

The following table describes the incremental synchronization parameters, which are displayed only when you have selected Incremental Synchronization on the Select Synchronization 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. Note The RPS and BPS values 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	This parameter will not be displayed if you have selected Full Synchronization. If you have selected Incremental Synchronization but not Full Synchronization, specify a point in time after which data is to be synchronized. The default value is the current system time. For more information, see Set an incremental synchronization timestamp.

Advanced parameters
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 or Incremental Synchronization > DDL Synchronization on the Select Synchronization Type page.
This parameter specifies the storage type for destination table objects during schema synchronization 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.
Note
The value Default means that other parameters are automatically set based on the parameter configurations of the destination. For table objects in schema synchronization or new table objects in incremental DDL synchronization, the schemas are subject to the specified storage type.

Click Precheck.
During the precheck, the data transmission service checks whether the schema of the logical table is the same as that of the physical table. The data transmission service checks only the column name, column type, and whether the column is empty but does not check the length or default value. 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. You can manually start the project on the Synchronization Projects page or by performing batch operations later. For more information about the batch operations, see Perform batch operations on data synchronization projects.
The data transmission service allows you to modify the synchronization objects when a synchronization project is running. For more information, see View and modify synchronization objects. After the data synchronization project is started, it will be executed based on the selected synchronization types. For more information, see View synchronization details.

If the data synchronization project encounters a running exception due to a network failure or slow startup of processes, you can click Recover on the Synchronization Projects page or on the Details page of the synchronization project.

ApsaraDB for OceanBase:Synchronize data between MySQL tenants of OceanBase Database