All Products
Search

This Product

    ApsaraDB for OceanBase:Download and import the settings of synchronization objects

    Document Center

    ApsaraDB for OceanBase:Download and import the settings of synchronization objects

    Last Updated:Jun 30, 2025

    The data transmission service allows you to download the settings of synchronization objects in a data synchronization task and supports automatic configuration and verification of object settings based on imported CSV files. This allows you to save task settings and configure multiple synchronization tasks at a time in a quick manner.

    Download object settings

    After you create a data synchronization task, you can download the settings of 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 task whose object settings you want to download in the Synchronization Tasks section.

      image.png

    4. On the details page of the task, click the ... icon in the upper-right corner, and then click Download Task Configuration in the drop-down list.

      Important

      You can specify objects for a data synchronization task between databases only when you select the Specify Objects mode.

      image.png

    Import object settings

    You can import CSV files to set row filter conditions, filter columns, and sharding columns. You can download the object settings file of an existing task or a template CSV file, modify the file as needed, and then import it.

    Important

    If you edit the object information in an Excel file, save the file as a CSV file, and then import the CSV file.

    The imported CSV file must contain the following columns: source database name, source table name, target database name, target table name, filter columns (separated with semicolons), column mapping, sharding columns (separated with semicolons), and row filter conditions.

    1. Log on to the ApsaraDB for OceanBase console and purchase a data synchronization task.

      For more information, see Purchase a data synchronization task.

    2. Choose Data Transmission > Data Synchronization. On the page that appears, click Configuration for the data synchronization task.

      image.png

    3. Configure the data synchronization task based on your business needs. In the Select Synchronization Objects step, click Import Objects in the upper-right corner of the right-side pane of the Select Synchronization Scope section.

      Note

      You can specify objects for a data synchronization task between databases only when you select the Specify Objects mode.

      image.png

      For more information, see the topics for data synchronization tasks of the corresponding types.

    4. In the dialog box that appears, click OK.

    5. Click Import CSV File in the lower part of the Import Synchronization Objects dialog box, and select a local CSV file to import it.

      image.png

      You can also click Download CSV Template in the lower part of the dialog box to download the template. Then, configure the settings in the template as needed and click Import CSV File to import the synchronization objects.

    6. Edit the CSV file as needed.

      Note

      • You can edit the CSV file manually or by using an SQL script. You can also click Download Task Configuration on the details page of the task to generate a CSV file.

      • You can enter names of databases or tables in the target database to establish a mapping between the source and target.

    7. Click Validate to check whether the source objects exist and whether the row filter conditions are correct. If the verification succeeds, the number of verified tables and views is displayed.

    8. Click OK to return to the Select Synchronization Objects step of the data synchronization task.

    9. Complete subsequent task settings as prompted.