Synchronize Schema

info

For the Free Plan, you can only sync from the latest schema version. Syncing from arbitrary schema versions is available in the Pro Plan and Enterprise Plan.

warning

This feature is in beta and only available for MySQL and PostgreSQL.

Synchronize Schema for MySQL currently supports synchronizing Table, Index, Constraint, View, Event, Trigger, and Function objects.

Synchronize Schema for PostgreSQL currently supports synchronizing Schema, Table, Index, Constraint, Sequence, Extension, Function, Trigger, and Enum Type objects.

Bytebase supports synchronizing a specified schema version of one database to others. To provide a better user experience, Bytebase displays the schema differences between the two selected databases and generates the suggested DDL statements (e.g. ALTER TABLE).

How to use

Step 1 - Go to the "Sync schema" page

Click the "Sync schema" button in the left navigation bar.

Step 2 - Select source schema

You need to select the project and source database schema version that you want to synchronize.

info

In the Enterprise Plan, you can select an arbitrary schema version from the migration history. In other plans, you can only select the latest schema version.

Step 3 - Select target databases

Select the target databases that will be synchronized with the chosen schema version in the previous step.

After you have selected a target database, Bytebase will show a schema diff between the two databases and generate the DDL statements. And you can further edit the generated content.

Step 4 - Preview issue

With the generated DDL statements, you can preview and create an "Alter Schema" issue. This kicks off the change workflow for the applied database.