Skip to content

first-schema-change.mdx

Latest commit

 

History

History
80 lines (50 loc) · 2.54 KB

first-schema-change.mdx

File metadata and controls

80 lines (50 loc) · 2.54 KB
title First Schema Change in 5 Minutes
author Adela
tags Tutorial
updated_at 2024/10/10 20:00
integrations General
category UI-Driven Workflow
level Beginner
estimated_time 5 mins
featured true

import PreparationWithSampleData from '/snippets/tutorials/preparation-with-sample-data.mdx';

Learn Bytebase's schema change workflow using sample databases.

Step 1 - Setup Bytebase

Step 2 - Configure SQL Review

  1. Navigate to CI/CD > SQL Review and click + Create SQL review.

  2. Select Sample Template (19 enabled rules), click Next. Attach to Prod environment and confirm.

Step 3 - Create a Plan

  1. Navigate to CI/CD > Plans and click + New Plan.

  2. Select both databases where changes will be applied:

    • hr_test on Test Sample instance
    • hr_prod on Prod Sample instance

    Click Confirm to proceed.

  3. Add this SQL statement (or use Schema Editor for visual design):

    ALTER TABLE public.employee ADD COLUMN IF NOT EXISTS nickname TEXT;

    Click Create.

  4. The plan is then in Draft status. Any SQL review warnings appear because Bytebase automatically checks against your configured policy. Click warnings for details.

    plan-warning-detail

Step 4 - Review and Approve

  1. Fix the warning by adding NOT NULL DEFAULT '':

    ALTER TABLE public.employee ADD COLUMN IF NOT EXISTS nickname TEXT NOT NULL DEFAULT '';

    Click Save. The checks rerun and pass.

  2. Click Ready for Review to convert the plan into an issue and submit for approval.

  3. No approval is required for this change. issue-2-targets-no-approval

Step 5 - Deploy Changes

  1. In the Rollout section, both Test and Prod deployments are ready. issue-2-targets-to-rollout

  2. Click Run for Test, then for Prod after success.

  3. Once complete, the issue is marked Done.

Next Steps

You've completed your first schema change. Continue with: