Deploy Schema Change with Rollout Policy

​

Features covered

• Level 1 – Automatic rollout (Rollout Policy) (available in all plans)
• Level 2 – SQL Review (available in all plans)
• Level 3 – Custom Approval (available in Enterprise)

​

Preparation

1. Ensure Docker is running, then start the Bytebase container:
   Copy

   Ask AI

   docker run --rm --init \
     --name bytebase \
     --publish 8080:8080 --pull always \
     --volume ~/.bytebase/data:/var/opt/bytebase \
     bytebase/bytebase:latest
   

   
2. Open Bytebase in localhost:8080, fill in the fields and click Create admin account. You’ll be redirected to Workspace.
3. During workspace setup, choose the built-in sample data.

​

Level 1: Automatic rollout in the Test environment (All plans)

1. In Workspace, go to Environments > Test, and set the rollout policy to Automatic.
2. From the top-left project switcher, select Sample Project. Under the CI/CD section, click Plans, then + New Plan. Choose Schema Migration (DDL) and select the hr_test database.
3. Using the Schema Editor, add a new column nickname to the employee table and click Confirm.
4. Click Create, then click Ready for Review.
5. The rollout executes automatically to the Test environment. The issue is marked as Done.

​

Level 2: Manual rollout with SQL Review (All plans)

1. In Workspace, go to Environments > Prod. Leave the rollout policy as the default Manual. We’ll add an SQL Review policy to the Prod environment.
2. Click SQL Review Policy to open SQL Review under the Environment > Prod. Select the Sample Template, which has 20 enabled rules.
3. Click Confirm to add the SQL Review policy to the Prod environment.
4. From the top-left project switcher, select Sample Project. Under the CI/CD section, click Plans, then + New Plan. Choose Schema Migration (DDL) and select the hr_prod database.
5. Using the Schema Editor, add a new column nickname to the employee table and click Confirm.
6. Intentionally violate the NOT NULL rule. Click Create; SQL Review runs automatically and shows a warning for the Prod task.
7. Click the warning to view details.
8. Fix the SQL by adding the NOT NULL constraint. Click Save to update the plan. SQL Review runs again and should pass. Click Ready for Review, then Confirm to submit the plan for approval.
9. The rollout is now ready to execute manually.
10. Click Rollout, then click Run.
11. After the rollout completes, the issue is marked as Done.

​

Level 3: Manual rollout with custom approval (Enterprise)

​

Summary

• GitOps: Observe Git pushes and trigger schema migrations.
• Batch changes: Change multiple databases in a single workflow.