This topic describes how to view and modify the synchronization objects of a data synchronization task in OceanBase Migration Service (OMS).
Background information
If the limitations are met, you can add or remove synchronization objects during synchronization. The changes made during the running of the task will be recorded. When an object addition task is completed, it is integrated with the associated original synchronization task. When the task integration is completed, the original synchronization task runs normally and the object addition task is automatically ended.
Limitations
For a data synchronization task in the Not Started, Running, or Stopped state, you can add or remove its synchronization objects.
Notice
For a data synchronization task in the Stopped state, you cannot add synchronization objects if the incremental synchronization step is in the Stopped state.
For a data synchronization task in the Failed state, you cannot add synchronization objects.
For a data synchronization task in the Modifying or Integrating state, you cannot modify its synchronization objects again.
If the incremental synchronization step of a data synchronization task is in the Stopped or Failed state, you cannot add synchronization objects.
When you synchronize data from an IDB logical table to a MySQL-compatible tenant of OceanBase Database or to a DataHub instance, you cannot remove synchronization objects.
View synchronization objects
Log in to the OMS console.
In the left-side navigation pane, click Data Synchronization.
On the Data Synchronization page, click the name of the target data synchronization task to go to its details page.
Click View Objects in the upper-right corner to view information on the Synchronization Objects and Object Modifications tabs.
The Synchronization Objects tab displays the synchronization objects of the current task. You can click Modify Object and then select Add Object or Remove Objects.
The Object Modifications tab displays the IDs, types, status, and time of all object modifications.
Add synchronization objects
On the details page of the target task, click View Objects in the upper-right corner.
In the View Objects dialog box, choose Modify Object > Add Object.
In the Add Object dialog box, select the synchronization objects in the left-side pane and click > to add the objects to the right-side pane. In the Map Object to Topic dialog box, select a mapping method.
After you select the synchronization objects to add, you can perform operations such as changing the topic and setting row filters.
Notice
By default, the newly added synchronization objects inherit all configurations of the original data synchronization task. If you abort the object addition operation, you must manually delete the objects that have been added to the target database.
If you have specified a schema name or database name for the source, you can add only the synchronization objects under the specified schema name or database name.
Then, click Next.
The system automatically performs a precheck on the added synchronization objects. After the added synchronization objects pass all check items, click Save.
Confirm the information and click OK in the dialog box that appears.
For a stopped or failed data synchronization task, you can cancel the operation and modify the synchronization objects again. The added synchronization objects will be migrated to the target database only after the data synchronization task returns to normal.
If you add synchronization objects for a running data synchronization task, after you click Save, the system immediately starts synchronizing the added synchronization objects to the target database.
When the object addition operation begins, records are generated. To view details of the records, choose View Objects > Object Modifications. The status of object addition records can be Pending, Canceled, Modifying, Running, Aborted, Integrating, Succeeded, or Failed. The operations that you can perform on an object addition record and the status of the original task depend on the status of the object addition record.
Note
If the original data synchronization task is in the Not Started state, a modification record in the Succeeded state will be generated for an object addition operation. If the original data synchronization task is in the Stopped state, a modification record in the Pending state will be generated for an object addition operation.
The status of an object addition record changes only when the original data synchronization task is in the Running state, and the status of the original task changes along with the status of the object addition record. The following table describes more information.
Status of an object addition record Supported operation Status of the original task Pending View details and cancel the addition. Running Canceled N/A. Running Modifying N/A. Modifying Running View details and abort the addition. Modifying Aborted View details. Running Integrating View details. Integrating Succeeded View details. Running Failed View details and retry.
You can also click View Cause to go to the details page of the task and view the cause of the failure.Modifying or Integrating
Remove synchronization objects
On the details page of the target task, click View Objects in the upper-right corner.
In the View Objects dialog box, choose Modify Object > Remove Objects.
In the Remove Objects dialog box, move the pointer over a synchronization object that you want to remove in the Target Object(s) section on the right and click Remove.
You can select multiple synchronization objects and then click Batch Remove. In the dialog box that appears, click OK.
In the lower-right corner of the Remove Objects dialog box, click Remove.
In the confirmation dialog box that appears, confirm the synchronization object to remove and click OK.
If the task is in the Stopped, Failed, or Running state, after you click OK, the synchronization object is immediately removed from the target database.
Notice
A removed synchronization object cannot be recovered. Proceed with caution.
The final result of the object removal operation is either succeeded or failed for all synchronization objects.
When the object removal operation begins, records are generated. To view details of the records, choose View Objects > Object Modifications. The status of object removal records can be Pending, Canceled, Modifying, Succeeded, or Failed. The operations that you can perform on an object removal record and the status of the original task depend on the status of the object removal record.
Status of an object removal record Supported operation Status of the original task Pending View details and cancel the removal. Running Canceled N/A. Running Modifying N/A. Modifying Succeeded View details. Running Failed View details and retry.
You can also click View Cause to go to the details page of the task and view the cause of the failure.Modifying