Skip to main content
Issue serves as the starting point for managing database changes, including Schema Change (DDL) and Data Change (DML). These changes follow a structured workflow: Plan, Review, Approve, and Rollout. For actions like Database Creation, the workflow might be simpler, omitting some steps.

​
Initiate an Issue with a Plan

  1. Navigate to CI/CD > Plans in your project menu and click + New Plan. new-plan
  2. Choose either Schema Migration (DDL) or Data Migration (DML). In this example, we select Schema Migration (DDL). After adding the first change, you can continue to add more changes within the same plan. plan-change-type
  3. Select one or more databases where the changes will be applied. Click Confirm to proceed. plan-targets
  4. If only one database is selected, you can use the Schema Editor to visually design the schema. new-plan-schema-editor

​
Review the Issue

  1. After clicking Confirm, you will be directed to the Plan page. Before clicking Create, you may choose to Run checks to execute the configured SQL review. plan-before-create-warning
  2. Once you click Create, the plan will enter Draft status. You may still encounter warnings. Address these warnings first. plan-draft-warning plan-draft-passed
  3. Click Ready for Review and then click Confirm. plan-ready-for-review

​
Approve the Issue

  1. The issue will await approval. The approval process is automatically matched by the custom approval. issue-to-approve
  2. Click Approve to authorize the plan by the designated approvers.

​
Deploy the Issue

  1. Once all approvals are secured, the rollout is ready to be executed. issue-to-rollout
  2. Click Run to deploy the issue. rollout-to-run run-rollout
  3. When all rollouts are successfully executed, the issue will be marked as Done. issue-done

​
Summary

An issue lifecycle: Plan -> Review -> Approve -> Rollout. issue-lifecycle Refer to Database Change Workflow for more details.