How Bytebase Tracks Database Change

With Bytebase, teams know who, what, when, why, how a database change has happened.

Issue Detail

Bytebase Issue is the container to capture a database change process. A single issue can contain a change to a single database as well as changes to hundreds of databases spanning multiple environments.

Who

1. Issue Creator
2. Reviewers according to the Rollout Policy
3. Subscribers interested in the progress.
4. Other participants can comment.

What

1. The target database instance, environment, and the database.
2. The SQL change statement.

When

You can specify when to deploy the issue (e.g. 2:00 midnight during non-business hours).

Why

1. Title to provide a change summary.
2. Description to provide detailed change context.
3. Labels to attach keyword information.
4. Comment to provide more context.

How

1. The database change process is organized into multiple stages.
2. The change is identified as high risk change and requires two approvers.
3. Checks
   • SQL Review checks various anti-SQL patterns.
   • Summary report shows the estimated impact.

Editing Activity Log

Change Execution Log

Change History

1. Affected Tables
2. Change statement
3. Change diff

Webhook Notification

Configure webhook to post change progress to the IM channel.

Summary

Different from a general issue tracking system like Jira, Bytebase is built specifically for the database change management. Bytebase provides much more context to track the entire database change process.