Schema Synchronization
Tutorial: How to Synchronize Database Schemas
Bytebase supports synchronizing a specified schema version of one source database to one or multiple target databases. You can use Schema Synchronization to:
- Propagate the schema changes from the one database to others.
- Revert the database schema to an old version.
The overall workflow:
- Compare a source database schema with one or multiple target databases’ schema.
- Generate the suggested DDL statements (e.g.
ALTER TABLE) to transit the source database schema state to each of the target database schema. - Create an issue.
- Deploy the DDL statements to the targeted databases.
Supported Objects
| Database | Objects |
|---|---|
| MySQL | Table, Index, Constraint, View, Event, Trigger, Function, Procedure |
| PostgreSQL | Schema, Table, Index, Constraint, View, Materialized View, Sequence, Extension, Function, Procedure, Trigger, Enum Type |
| TiDB | Table, Index, Constraint, View |
| Oracle | Table, Index, Constraint |
| Microsoft SQL Server | Table, Index, Constraint |
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.
In the Enterprise and Pro 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.