When modifying data in the database, it’s crucial to ensure that the changes are both safe and accurate. Bytebase offers a feature called SQL Review, which allows you to evaluate your SQL changes before they are applied to the database. SQL Review can be invoked from the Bytebase GUI, CI or API.

This is one of the tutorial series of SQL Review:

  1. SQL Review with Bytebase GUI
  2. SQL Review with CI (integrated with Database GitOps workflow):
  3. SQL Review with Bytebase API (this one)
  4. Codify SQL Review Policies with Bytebase API

This tutorial will walk you through using SQL Review in Bytebase with Bytebase API to improve your database schema change process. The Community Plan is sufficient for completing this tutorial.

​
Prerequisites

Make sure you have completed the previous tutorial SQL Review with Bytebase GUI.

If you want to test the SQL Review API locally, you may need to configure ngrok.

ngrok is a reverse proxy tunnel that provides a public network address to access Bytebase. We use ngrok here for demonstration purposes.

  1. Run Bytebase in Docker with the following command:

    docker run --rm --init \
  --name bytebase \
  --publish 8080:8080 --pull always \
  --volume ~/.bytebase/data:/var/opt/bytebase \
  bytebase/bytebase:3.8.0

  2. Once Bytebase is running in Docker, you can access it at localhost:8080.

  3. Log in to the ngrok Dashboard and complete the Getting Started steps to install and configure ngrok. To use a consistent domain, navigate to Universal Gateway > Endpoints to find your assigned domain: <<YOURS>>.ngrok-free.app.

  4. Start ngrok with your domain by running:

    ngrok http --url=<<YOURS>>.ngrok-free.app 8080

    You should see output similar to this:

  5. You can now access Bytebase at https://<<YOURS>>.ngrok-free.app.

  6. (Optional) To configure SSO (Entra/SCIM), Log in to Bytebase, click Settings > General in the left sidebar. Scroll to the Network section, set https://<<YOURS>>.ngrok-free.app as the External URL and click Confirm and update.

​
API Examples

You may call Bytebase API in your internal portal or GitHub Actions to trigger SQL Review. Check out https://github.com/bytebase/example-api/tree/main/issue-creation

You can also call the API to configure SQL Review policies.

Tutorial: Codify SQL Review Policies with Bytebase API

​
Summary

Now you have learned how to trigger SQL Review in Bytebase API. You may also refer to the SQL Review document for more details. Next, let’s learn how to codify SQL Review policies with API