All Products
Search
Document Center

:Shadow table synchronization tasks

Last Updated:Mar 16, 2023

Background

OceanBase Developer Center (ODC) allows you to apply for permissions to create shadow table synchronization tasks from the administrator of the public resource console.

After you create a shadow table synchronization task in Task Center, the administrator can approve the task in the task list in Task Center, where you can view the task information and approval status.

Lists of tasks

Note

The task list displays the tasks created in the last 48 hours.

After you enter the target database connection, click Task Center in the top navigation bar to open the Task Center panel. Click the Synchronize Shadow Table tab to view the shadow table synchronization tasks.

imageThe following table describes the columns contained in the task list on this tab contain. You can filter and sort the tasks in the list.

Column

Description

Task ID

The ID of the task.

Task Type

The type of the task specified when you created the task.

Connection

The name of the database connection to which the task belongs.

You can click the filter icon Filter to filter tasks by connection.

Database

The name of the target database where the task operates.

You can click the search icon Search to search for tasks of a specific database.

Created By

The user whose created the database connection task.

You can click the search icon Search to search for tasks created by a specific creator.

Created At

The date and time when the task was generated.

Task Status

The current status of the task. ODC provides different management actions for tasks in different states.

Actions

ODC provides task management options such as View and Approve/Reject.

  • View: You can click this button to go to the task details page to view the task information and task process.

  • Approve/Reject: You can click this button to approve or reject the task.

  • Abort: You can click this button to abort a running task.

Create a shadow table synchronization task

  1. Log on to ODC. Click Task Center in the top navigation bar. On the Task Center panel that appears, click + on the right side of Synchronize Shadow Table, and a new synchronize shadow table task panel will pop up.

  2. On the Create Shadow Table Synchronization Project panel, specify the following information.

    1. Select a synchronization object.

      image

      Item

      Description

      Database

      The database to which the shadow table to be created belongs. You can view the name of the current connection.

      Synchronization Range

      The table to be synchronized.

      • Partial Tables: Shadow tables will be created in the current database for the selected tables. Click the checkbox icon on the left side of the search box to support select all tables.

      • All Tables: Shadow tables will be created in the current database for all tables in the source database.

      Name of Shadow Table

      The name of the shadow table, in the format of prefix + source table name or source table name + suffix. You can use custom prefix or suffix.

      Synchronization Objects

      The source tables to be synchronized as shadow tables. You must specify this field when Synchronization Range is set to Partial Tables.

    2. Analyze the schema of the shadow table.

      image

      Item

      Description

      Synchronized Tables

      The Synchronized Tables tab displays the source table name, shadow table name, and analysis result. You can click View to view the source table schema, shadow table schema, and schema change SQL statement, or click Skip, indicating that this shadow table is not synchronized.

      Unsynchronized Tables

      The Unsynchronized Tables tab displays the source table name, shadow table name, and analysis result. You can click Undo Skip to synchronize this shadow table.

      Note

      A skipped table will be displayed on the Unsynchronized Tables tab. If a shadow table with the same name and the same schema as the source table already exists, schema synchronization will be skipped.

      SQL Preview

      The SQL statement for schema synchronization.

      Task Settings

      Options of Execution Mode include:

      • Execute Immediately: The synchronization task is executed immediately.

      • Execute On Schedule: The synchronization task is executed on schedule.

      Options of Task Error Handling Method include:

      • Abort Task: If an error occurs during the execution of the synchronization task, the subsequent SQL scripts are interrupted and no longer executed.

      • Ignore Error and Continue: If an error occurs during the execution of the synchronization task, the SQL script with the error is skipped, but subsequent SQL scripts will be executed.

      Remarks

      The business background of the project, such as the change purpose and expected goal.

  3. Click Submit.

    Note

    After a task is created, the task will automatically match the application process of shadow table synchronization task created by the administrator on the public resource console.

    Tasks will be executed based on the priority order set by the administrator in Set Priority on the public resource console. For more information about task processes, see Manage task processes.

View the shadow table synchronization task

Task information

  1. Click Task Center in the top navigation bar, and click the Synchronize Shadow Table tab. In the task list on the tab, click View in the Actions column of the target task to view its details.

  2. On the Task Details panel, click the Task Information tab to view the basic task information and task settings.

    Information

    Description

    Basic information

    You can view the status, ID, type, connection, database, execution mode, error handling method, remarks, creator, and creation time of the task.

    Task settings

    You can view the tables to be synchronized, tables not to be synchronized, and SQL scripts to be executed.

  3. On the Task Details panel, click Initiate Again in the lower-right corner to initiate the task again.

Task Process

  1. In the Task Details panel, click the Task Process tab to view information about the task process, including the task initiation information, approval status, execution status, and completion status.

  2. You can click Initiate Again in the lower-right corner of the panel to re-initiate the task.

Task logs

  1. On the Task Details panel, click the Task Logs tab to view all logs and alert logs of the task.

    Item

    Description

    All Logs

    Displays the complete information of all task logs, including INFO, ERROR, and WARN logs.

    You can click Search, Download, or Copy to search for, download, or copy all logs.

    Alert Logs

    Displays the ERROR and WARN logs of the task. When a task fails, you can view the error message in the alert logs.

    You can click Search,Download, or Copy to search for, download, or copy alert logs.

  2. You can click Initiate Again to initiate the task again.