Background information
The shadow table synchronization feature of OceanBase Developer Center (ODC) allows you to automatically create a shadow table in the current database based on the schema of the source table. The shadow table name is the combination of the source table name and a prefix or suffix. This feature applies to scenarios like end-to-end stress testing.
This topic provides an example of creating a shadow table and describes how to create a shadow table named employee_t in the database odc_test.
Note
- The data used in this topic is sample data. You can replace it with actual data as needed.
- The shadow table synchronization feature of ODC V4.0.0 and later supports only the MySQL compatible mode. If the source table contains subpartitions, only HASH/KEY subpartitions are supported.
- After a shadow table is created, you can view it on the Table page.
- When a shadow table is created, if a table with the same name but a different schema already exists, a synchronization SQL statement is generated to update the schema of the existing shadow table.
Create a shadow table synchronization task
Choose Projects > All Projects. On the tab that appears, click the project name.
On the Tickets tab, choose Shadow Table Sync > Create New.
On the Create Shadow Table Synchronization Project panel, specify the following information and click Create.
Select a synchronization object.
ParameterDescriptionDatabase The database to which the shadow table to be created belongs. You can view the name of the current data source. Synchronization Range The table to be synchronized. - Partial Tables: Shadow tables will be created in the current database for the selected tables. You can also check the Select All box on the left of the search box to select all source 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 a 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. Click Next to analyze the structure of the shadow table.
ParameterDescriptionSynchronized 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:
- Manual Execution: The synchronization task is triggered manually.
- Immediate Execution: The synchronization task is executed immediately.
- Scheduled Execution: 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.
- Select the Table Name Switch mode.
- Automatic Switch : Automatically switch the table name during the task.
- Manual Switch : Manually switch the table name during the task.
Description The business background of the project, such as the change purpose and expected goal. - Options of Execution Mode include:
After the task is generated, you can click Shadow Table Sync on the Tickets tab to view the task information.
View the shadow table synchronization task
Go to Tickets > Shadow Table Sync. In the shadow table synchronization task list, click the name of the target task to view the task details. You can also click ··· in the Actions column to perform more operations.
- Execute: If the task is set to manual execution, you can manually execute the task.
- Terminate: If the task is set to periodic or scheduled execution, you can terminate the task. You can also select the target ticket and click the Batch Actions button at the top to terminate multiple tickets at once.
- Disable/Enable: If the task is set to periodic or scheduled execution, you can disable the task to temporarily stop its execution. The task will resume execution after it is re-enabled.
- Edit: If the task is disabled, you can edit the task to update its content.
- Delete: If the task is completed or terminated, you can delete the task.
- View: View the task details.
- Clone: Clone the task execution content to quickly generate a new task with the same configuration.
- Share: Quickly copy the task's access URL.
In the task details panel that appears, the Basic Information tab is displayed by default. You can view the task type, database, variable configuration, and execution method.
In the task details panel, click the Workflow tab to view the task initiation status, approval status, execution status, and execution result.
In the task details panel, click the Logs tab to view all logs and alert logs of the task.
ItemDescriptionAll Logs All logs display the INFO, ERROR, and WARN logs of the task. You can click Find, Download, and Copy to find, download, or copy all logs. Alert Logs Alert logs display the ERROR and WARN logs of the task. You can view error information in alert logs when the task fails. You can click Find, Download, and Copy to find, download, or copy alert logs.