Plan

A Plan manages a database change throughout its lifecycle: SQL and targets, checks, review, and deployment. In the UI workflow, its linked Issue records review and its Rollout tracks execution. Submitting for review does not convert the Plan into an Issue. This page covers UI Plan authoring. Follow the UI tutorial for a complete example, or the GitOps tutorial for Release-based Plans.

​

1. Create Plan

In your project, navigate to CI/CD > Plans and click + New Plan.

​

2. Select Databases

Choose one or more target databases and click Confirm.

​

3. Add Changes

Enter SQL for the selected targets. Use Add Change for another change with its own SQL and targets. Click Create to save a draft Plan and its linked draft Issue. Bytebase runs automated checks; the SQL has not executed yet.

​

4. Submit for Review

Inspect the checks, correct errors, and assess warnings. Click Ready for Review to submit the linked Issue. The Plan remains the page for managing the change. Approval follows configured rules; if no human approval is required, the approval flow says No approval required. The plan detail page shows a Review section where you can follow the approval flow and the activity timeline while the change awaits approval.

​

5. Deploy

Once approval is satisfied and checks finish without errors, Bytebase automatically creates the Rollout. Follow execution in Deploy. Manual environments wait for an authorized user to click Run; automatic environments follow their Rollout Policy. Deploy to Test first, then Prod after success.