ApsaraDB for OceanBase:View and modify synchronization objects and their filter conditions

Background

You can add or remove synchronization objects and modify their filter conditions during synchronization under the specified limitations. The changes made are recorded. When an object addition task is completed, it is integrated with the associated original task. When the integration is completed, the original task runs normally and the object addition task is automatically released.

For information about how to modify the synchronization objects selected based on matching rules and modify the SQL filter conditions of these objects, see Configure and modify matching rules.

Limitations

• For a data synchronization task in the Not Started, Running, or Stopped state, you can add or remove its synchronization objects.

  Important

  For a data synchronization task in the Stopped state, if the Incremental Synchronization step of the task is also in the Stopped state, you cannot add its synchronization objects.

• For a data synchronization task in the Failed state, you cannot add its synchronization objects.

• For a data synchronization task in the Modifying or Integrating state, you cannot modify its synchronization objects again.

• When the Incremental Synchronization step of a data synchronization task is in the Stopped or Failed state, you cannot add its synchronization objects.

• For a data synchronization task in the Stopped, Failed, Not Started, or Running state, you can modify its row filter conditions.

View synchronization objects

1. Log on to the

   ApsaraDB for OceanBase console.

2. In the left-side navigation pane, choose Data Transmission > Data Synchronization.

3. On the Data Synchronization page, click the name of the target task to go to its details page.

   

4. Click View Objects in the upper-right corner and view information on the Synchronization Objects and Object Modifications tabs.

   • The Synchronization Objects tab displays the synchronization objects of the current task. You can add or remove objects, and modify their row filter conditions.

   • The Object Modifications tab displays the types, status, and occurrence time of all object modifications.

Add synchronization objects

1. On the details page of the target task, click View Objects in the upper-right corner.

   

2. In the View Objects dialog box, choose Synchronization Objects > Add Objects.

   

3. In the Add Objects dialog box, select the synchronization objects to add.

   Important

   • By default, the newly added objects inherit all configuration options 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 data source, you can add only the synchronization objects under the specified schema name or database name.

   • If the target of the data synchronization task is a message queue, in the Add Objects dialog box, select synchronization objects in the left-side Source Object(s) section and click > to add them to the right-side list. In the Map Object to Topic dialog box, select a mapping method as needed.

     

     After you select the synchronization objects to add, you can perform operations such as changing the topic, setting row filters, and removing objects.

     

   • If the target of the data synchronization task is a database, in the Add Objects dialog box, select synchronization objects in the left-side Source Object(s) section and click > to add them to the right-side list.

     

     After you select the synchronization objects to add, you can perform operations such as renaming target objects, setting row filters, and removing objects.

     

4. Click Next.

5. The system automatically performs a precheck on the added objects. After the added objects pass all check items, click Save.

6. Confirm the information and click OK in the dialog box that appears.

   • For a stopped or failed task, you can cancel the operation and modify the objects again. The objects will be added only after the data synchronization task is resumed.

   • If you add objects for a running task, after you click Save, the objects are immediately added.

   When an object addition operation begins, the corresponding record is generated. To view the details of the record, click View Objects on the details page of the task and then click the Object Modifications tab.

   

   The status of an object addition record 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 vary with the status of the object addition record.

   Note

   If the original task is in the Not Started state, a modification record in the Succeeded state is generated for an object addition operation. If the original task is in the Stopped state, a modification record in the Pending state is generated for an object addition operation.

   The status of an object addition record changes only when the original 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.	Running
   Canceled	None	Running
   Modifying	None	Modifying
   Running	View details and abort.	Modifying
   Aborted	View details.	Running
   Integrating	View details.	Integrating
   Succeeded	View details.	Running
   Failed	View details and retry. You can also click View Causes to go to the task details page and view the failure causes.	Modifying or Integrating

Remove synchronization objects

1. On the details page of the target task, click View Objects in the upper-right corner.

   

2. In the View Objects dialog box, choose Synchronization Objects > Remove Objects.

   

3. In the Remove Objects dialog box, hover over a synchronization object that you want to remove in the Target Object(s) section on the right and click Remove.

   

   If the target of the data synchronization task is a message queue, you can select multiple synchronization objects and then click Batch Remove. In the dialog box that appears, click OK.

   

4. In the Remove Objects dialog box, click Remove.

5. In the confirmation dialog box that appears, confirm the object to remove and click OK.

   If the task is in the Stopped, Failed, or Running state, after you click OK, the object is immediately removed.

   Important

   • A removed object cannot be recovered. Proceed with caution.

   • The final result of the object removal operation is either succeeded or failed for all objects.

   When an object removal operation begins, the corresponding record is generated. To view the details of the record, click View Objects on the details page of the task and then click the Object Modifications tab.

   

   The status of an object removal record 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 vary with 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.	Running
   Canceled	None	Running
   Modifying	View details.	Modifying
   Succeeded	View details.	Running
   Failed	View details and retry. You can also click View Causes to go to the task details page and view the failure causes.	Modifying

Modify the filter conditions for synchronization objects

You can modify the SQL conditions to filter data for synchronization objects selected by using the Specify Objects option when a data synchronization task is running.

1. On the details page of the target task, click View Objects in the upper-right corner.

   

2. In the View Objects dialog box, click the Synchronization Objects tab, expand the target schema, hover over the target object, and click Settings.

   

3. In the Row Filters section of the Settings dialog box, specify a standard SQL WHERE clause to configure or modify row filters. For more information, see Use SQL conditions to filter data.

   

4. Click Validate Syntax.

5. After the validation succeeds, click OK in the Settings dialog box.

6. In the dialog box that appears, click Apply to apply the modification to the object.

7. On the Object Modifications tab, view the modification progress.

   

   You can also click View Details to go to the Modify Setting Details page, hover over the target data table, and click View Settings to view the modified row filters.