Database CI/CD and Schema Migration with SQL Server

Estimated: 20 mins
Database CI/CD and Schema Migration with SQL Server

A series of articles about Database CI/CD and Schema Migration with SQL Server.


Microsoft SQL Server is a widely used database management system developed by Microsoft for storing and retrieving structured data. It offers features for data management, scalability, performance optimization, security, and business intelligence.

This tutorial is a step-by-step guide to set up Database Change Management for SQL Server in Bytebase. With Bytebase, a team can have a formalized review and rollout process to make SQL Server database schema change and data change.

Bytebase provides a GUI for teams to perform database changes and retain full migration history. Bytebase Free Plan is sufficient for this tutorial.

Prerequisites

Before you start, make sure you have the following downloaded and installed:

  • One SQL Server instance
  • Docker

Step 1 - Deploy Bytebase via Docker

  1. Make sure your Docker is running, and start the Bytebase Docker container with the following command:

    docker run --rm --init \
      --name bytebase \
      --publish 8080:8080 --pull always \
      --volume ~/.bytebase/data:/var/opt/bytebase \
      bytebase/bytebase:2.15.0
  2. Bytebase is now running via Docker, and you can access it via localhost:5678.

  3. Visit localhost:5678 in your browser. Register an account. bb-register

Step 2 - Add a SQL Server Instance to Bytebase

In this tutorial, ​an Instance is your SQL Server instance.

  1. Login to the Bytebase Console.

  2. Click Instances on the left sidebar and click Add Instance.

  3. Add an SQL Server instance. Pay attention to Environment, let's choose Prod for this tutorial. Because there's a SQL Review policy enabled on Prod environment. You may go to Environment > Prod > SQL Review Policy to check the details. add-instance

Step 3 - Go to the existing Project

In Bytebase, Project groups logically related Databases, Issues and Users together, which is similar to the project concept in other DevTools such as Jira and GitLab. So before you deal with the database, a Project must be presented.

Go to the Projects tab, and you'll see a default project called Sample Project. Click it, there are two sample PostgreSQL databases. We'll create a new SQL Server database in this project.

Step 4 - Create a SQL Server database via Bytebase

In Bytebase, a Database is created by CREATE DATABASE xxx. A database always belongs to a single Project. An Issue represents a specific collaboration activity between Developer and DBA for when creating a database, altering a schema. It's similar to the issue concept in other issue management tools.

  1. Stay in the project Sample Project. Click on New DB to create a new database.

  2. Fill in the form, and pay attention to these fields: create-db

    • Name: can be anything, here we used db_demo
    • Environment - Prod
    • Instance - choose the instance you added in Step 2.

    Click Create.

  3. Bytebase will create an issue to create the database automatically and without further configuration, the rollout is approved by default. The issue is Done after the rollout succeeds. bb-db-created-done

Step 5 - Create a table in SQL Server via Bytebase

In Step 4, you actually created an issue using UI workflow and then executed it. Let’s make it more explicit.

  1. Go to project Sample project, check db_demo you created and click on Edit Schema.

  2. You'll be redirected to an issue preview. Fill in the following SQL and click Create.

    CREATE TABLE t1 (id INT);
  3. After automatic checks, there's a pop-up window showing a SQL Review violation -- Enforce NOT NULL constraint for columns.

    bb-sql-review-violations

  4. Click Back to edit, and paste this and click Create again.

    CREATE TABLE t1 (id INT NOT NULL DEFAULT 1);
  5. After passing the automatic checks, the issue executes and the status becomes Done.

    bb-issue-create-table-done

Summary and What's Next

Now you have connected SQL Server with Bytebase, and used the UI workflow to accomplish schema change. Bytebase will record the full migration history for you.

In the next post, you’ll try out GitOps workflow: store your SQL Server schema in GitHub and Bytebase will pick up the changes to the repo, bringing your SQL Server change workflow to the next level, aka Database DevOps - Database as Code.

Edit this page on GitHub

Subscribe to Newsletter

By subscribing, you agree with Bytebase's Terms of Service and Privacy Policy.