OceanBase
English日本語简体中文
Docs Home
Products
Integrations
Release Notes

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Databases

OceanBase DatabaseOceanBase Cloud OceanBase Best Practices

Connectors and Middleware

OceanBase Database Proxy OceanBase Connector/C OceanBase Connector/J OceanBase Connector/ODBC OceanBase Connector/NETOceanBase Command-Line Client

Tools

OceanBase Cloud PlatformOceanBase Migration ServiceOceanBase Developer CenterOceanBase Migration AssessmentOceanBase Admin ToolOceanBase Loader and DumperOceanBase DeployerKubernetes operator for OceanBaseOceanBase Diagnostic Tool OceanBase Binlog Service
OceanBase DatabaseOceanBase Cloud ToolsConnectors and MiddlewareLifecycle Support Policy

OceanBase Developer Center

V4.2.4
  • Overview
    • What is ODC?
    • Features
    • Architecture
    • Limitations
    • ODC console
  • Quick Start
    • Client ODC
      • Overview
      • Install Client ODC
      • Use Client ODC
    • Web ODC
      • Overview
      • Deploy Web ODC
      • Use Web ODC
  • Data Source Management
    • Create a data source
    • Data sources and project collaboration
    • Database O&M
      • Session management
      • Global variable management
      • Recycle bin management
  • SQL Development
    • Write and execute SQL statements
    • Perform PL compilation and debugging
    • Use the command-line window
    • Edit and export the result set of an SQL statement
    • Analyze SQL statements
    • Generate test data
    • Database objects
      • Table objects
        • Overview
        • Create a table
        • Table list
        • Manage table attributes
        • Manage table data
      • View objects
        • Overview
        • Create a view
        • Manage views
      • Function objects
        • Overview
        • Create a function
        • Manage functions
      • Stored procedure objects
        • Overview
        • Create a stored procedure
        • Manage stored procedures
      • Sequence objects
        • Overview
        • Create a sequence
        • Manage sequences
      • Package objects
        • Overview
        • Create a program package
        • Manage program packages
      • Trigger objects
        • Overview
        • Create a trigger
        • Manage triggers
      • Type objects
        • Overview
        • Create a type
        • Manage types
      • Synonym objects
        • Overview
        • Create a synonym
        • Manage synonyms
  • Import and Export
    • Import schemas and data
    • Export schemas and data
  • Database Change Management
    • User Permission Management
      • Users and roles
      • Automatic authorization
    • Project collaboration management
    • Risk levels, risk identification rules, and approval processes
    • SQL check specifications
    • SQL window specification
    • Database change management
    • Lock-free schema changes
    • Synchronize shadow tables
    • Schema comparison
    • Message notification management
  • Data Lifecycle Management
    • Archive data
    • Clean up data
    • Partitioning Plan Management
      • Manage partitioning plans
      • Set partitioning strategies
      • Examples
    • SQL plan task
  • Data Desensitization and Auditing
    • Desensitize data
    • Operation records
  • System Integration
    • Login integration
    • Approval integration
    • SQL approval integration
  • Deployment Guide
    • Deployment overview
    • Preparations before deployment
    • Deploy ODC in single-node mode
    • Deploy ODC in high-availability mode
    • Deployment verification
  • Upgrade Guide
    • Preparations before upgrade
    • Update single-node ODC
    • Update high-avaliability ODC
    • Upgrade verification
    • Rollback after upgrade failed
  • Troubleshooting
    • ODC troubleshooting process
    • Collect Message
      • View the runtime environment and version information
      • View web ODC logs
      • View client ODC logs
      • View end-to-end ODC-related logs
      • View ODC MetaDB data
      • Query the index status in OceanBase Database V4.x
      • Query the index status in OceanBase Database V1.4.x to V3.2.x
      • Collect JVM runtime information
      • Use tcpdump to capture packets
    • Common Troubleshooting
      • Deployment Upgrade
        • Web ODC cannot be accessed after startup
      • Database Connection
        • Access denied in a connection trial or test
        • Connection is refused in a connection trial or test
        • Connection times out
        • `Connection reset` is reported for a time-consuming statement
        • `socket write error` or `closed by server` is reported for a connection
      • SQL Execution
        • Disconnection during SQL execution
        • `Over tenant memory limits` is reported during SQL execution
        • `Unknown thread id` is returned during SQL execution
        • `timeout` errors returned during SQL execution
        • `OutOfMemoryError` is returned during SQL execution
        • Incomplete result columns for the SELECT statement
        • Garbled Chinese characters in the SQL execution result set
        • Garbled Chinese data is returned for query of data in GBK encoding
      • PL Object
        • Debugging is not supported for invalid PL objects
        • `JSONException` is reported during PL debugging
        • Garbled variable values in debugging
        • Failed to view PL objects or garbled characters are returned
        • PL objects cannot be executed or an execution error is returned
        • ODC issues during PL debugging
        • PL anonymous block cannot be debugged
        • Alert information of a PL object is unavailable
      • Import and Export
        • Garbled Chinese characters in an imported file in GBK encoding
        • Invalid ZIP package reported during file import
        • Time-type data exported from an Oracle tenant cannot be imported
        • Mismatched columns reported during the import of a single-table CSV file
        • Failed to export a result set in ODC to an Excel file
        • Incorrect display in Excel for a result set exported in CSV format
        • Incomplete data in batch export of multiple tables
        • `javax.crypto.BadPaddingException: Given final block not properly padded` is returned for a data import or export failure
      • Client ODC Problems
        • Client ODC startup failure / H2 Database corruption: Chuck not found
        • Garbled Chinese characters in the command-line window of ODC
        • Failed to install client ODC
        • Client ODC startup failure or no response
        • `Not a valid secret key` is returned for connection creation in client ODC
        • `User does not exist` returned for connection creation in client ODC
        • High memory usage of client ODC
        • Client ODC fails to be installed or start due to a port conflict
      • Front-end Page Exception
        • JavaScript exception is thrown on the ODC page
        • No response in browser after opening ODC
        • White screen in ODC
      • Account Password Problem
        • Forgot the admin account password in ODC V3.2.0 or later
        • Forgot an account password in ODC V2.4.1 to V3.1.3
        • Forgot an account password in ODC V2.4.0 or earlier
    • FAQ
      • Installation of client ODC
      • Web ODC deployment and startup
      • FAQ
      • Command-line window
      • DDL statement display
  • Release Note
    • V4.2
      • ODC V4.2.4
      • ODC V4.2.3
      • ODC V4.2.2
      • ODC V4.2.0
      • ODC V4.2.1
    • V4.1
      • ODC V4.1.2
      • ODC V4.1.1
      • ODC V4.1.0
    • V4.0
      • ODC V4.0.2
      • ODC V4.0.0
    • V3.4
      • ODC V3.4.0
    • V3.3
      • ODC V3.3.3
      • ODC V3.3.2
      • ODC V3.3.1
      • ODC V3.3.0
    • V3.2
      • ODC V3.2.3
      • ODC V3.2.2
      • ODC V3.2.1
      • ODC V3.2.0

Download PDF

Document Feedback
  1. Documentation Center
  2. OceanBase Developer Center
  3. V4.2.4

Synchronize shadow tables

Last Updated:2026-09-03 09:11:16

Background information
Create a shadow table synchronization task
View shadow table synchronization tasks
Task information
Task process
Task logs
References

This topic introduces how to create and view shadow table synchronization tasks in ODC.

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.

Note

  • The shadow table synchronization feature of ODC V4.0.0 and later supports only the MySQL 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

Assume that you want to create a shadow table named employee_t in the odc_test database under the mysql410 data source.

Parameter
Example
Data Source mysql4.2.0
Database Name odc_test
Source Table Name employee
Shadow Table Name employee_t
  1. On the Ticket tab in the SQL development window, choose Synchronize Shadow Table > Create Shadow Table Synchronization Project.

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

    1. Select a synchronization object.

      Parameter
      Description
      Database 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.
    2. Click Next to analyze the structure of the shadow table.

      Parameter
      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.
      Description The business background of the project, such as the change purpose and expected goal.
  3. After you specify the preceding information, click Submit in the lower-right corner of the panel.

  4. After a task is generated, the Tasks panel appears. In the Task panel, you can view the approval status and information about the task.

View shadow table synchronization tasks

Task information

  1. In the shadow table synchronization list on the Tasks page, click View in the Actions column.

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

  3. In 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 Initiated Task Status, Approval Status, Execution Status, and Completion Result.

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

Task logs

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

    Parameter
    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.

References

  • Edit and execute SQL statements

  • PL compilation and debugging

  • Command-line window

  • Edit and export results

  • Analyze SQL statements

  • Generate mock data

  • Manage database changes

  • Manage partitions

  • Change lock-free structures

Previous topic

Lock-free schema changes
Last

Next topic

Schema comparison
Next
on this page
Background information
Create a shadow table synchronization task
View shadow table synchronization tasks
Task information
Task process
Task logs
References