Skip to content

Commit bdcc674

Browse files
update step-by-step change schema
1 parent a2ae075 commit bdcc674

File tree

5 files changed

+3
-31
lines changed

5 files changed

+3
-31
lines changed
-29.7 KB
Binary file not shown.
-40.7 KB
Binary file not shown.
-61.9 KB
Binary file not shown.
-45.6 KB
Binary file not shown.

docs/get-started/step-by-step/change-schema.mdx

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -8,60 +8,32 @@ title: 'Step 6: Change Schema'
88

99
1. Navigate to **CI/CD** > **Plans** in your project menu and click **+ New Plan**.
1010

11-
![new-plan](/content/docs/change-database/plan/bb-new-plan.webp)
12-
13-
1. 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.
14-
15-
![plan-change-type](/content/docs/change-database/plan/bb-plan-change-type.webp)
16-
1711
1. Select one or more databases where the changes will be applied. Click **Confirm** to proceed.
1812

19-
![plan-targets](/content/docs/change-database/plan/bb-plan-targets.webp)
20-
21-
1. If only **one** database is selected, you can use the **Schema Editor** to visually design the schema.
22-
23-
![new-plan-schema-editor](/content/docs/change-database/schema-editor/bb-new-plan-schema-editor.webp)
13+
1. Input the SQL statement you want to apply to the database. You may click **Schema Editor** to visually design the schema if needed.
2414

2515
## Review the Issue
2616

27-
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](/sql-review/review-policy).
28-
29-
![plan-before-create-warning](/content/docs/get-started/step-by-step/change-schema/bb-plan-before-create-warning.webp)
17+
1. Before clicking **Create**, you may choose to **Run checks** to execute the [configured SQL review](/sql-review/review-policy). It will be automatically executed when you click **Create**, too.
3018

3119
1. Once you click **Create**, the plan will enter `Draft` status. You may still encounter warnings. Address these warnings first.
3220

33-
![plan-draft-warning](/content/docs/get-started/step-by-step/change-schema/bb-plan-draft-warning.webp)
34-
35-
![plan-draft-passed](/content/docs/get-started/step-by-step/change-schema/bb-plan-draft-passed.webp)
36-
37-
1. Click **Ready for Review** and then click **Confirm**.
38-
39-
![plan-ready-for-review](/content/docs/get-started/step-by-step/change-schema/bb-plan-ready-for-review.webp)
21+
1. Click **Ready for Review** and the issue is ready for review.
4022

4123
## Approve the Issue
4224

4325
1. The issue will await approval. The approval process is automatically matched by the [custom approval](/change-database/approval).
4426

45-
![issue-to-approve](/content/docs/get-started/step-by-step/change-schema/bb-issue-to-approve.webp)
46-
4727
1. Click **Approve** to authorize the plan by the designated approvers.
4828

4929
## Deploy the Issue
5030

5131
1. Once all approvals are secured, the rollout is ready to be executed.
5232

53-
![issue-to-rollout](/content/docs/get-started/step-by-step/change-schema/bb-issue-to-rollout.webp)
54-
5533
1. Click **Run** to deploy the issue.
5634

57-
![rollout-to-run](/content/docs/get-started/step-by-step/change-schema/bb-rollout-to-run.webp)
58-
59-
![run-rollout](/content/docs/get-started/step-by-step/change-schema/bb-run-rollout.webp)
60-
6135
1. When all rollouts are successfully executed, the issue will be marked as `Done`.
6236

63-
![issue-done](/content/docs/get-started/step-by-step/change-schema/bb-issue-done.webp)
64-
6537
## Summary
6638

6739
An issue lifecycle: Plan -> Review -> Approve -> Rollout.

0 commit comments

Comments
 (0)