Release

After PR/MR merge, Bytebase creates a release, compares the desired state with current database state, generates migration DDL, and deploys.

How SDL Release Works

State Comparison - Bytebase compares your SDL files with current database schema
DDL Generation - Automatically generates ALTER/DROP statements using topological sort
Migration Execution - Applies generated DDL to reach desired state
Revision Tracking - Records new version for future comparisons

CI/CD Integration

Add --declarative flag to enable SDL mode:

Use a compatible bytebase-action image. For Bytebase Cloud, use bytebase/bytebase-action:cloud. For self-hosted Bytebase, replace :cloud with your Bytebase server version, for example :3.14.0.

The examples assume your SDL files live under a schema/ directory - for example schema/tables/users.sql (MySQL) or schema/schemas/public/tables/users.sql (PostgreSQL). If your files live elsewhere, adjust the trigger paths and --file-pattern. The pattern supports ** globs and brace alternation, for example {schemas,tables,views,functions,procedures,triggers,events}/**/*.sql for an export extracted at the repository root.

GitHub Actions
GitLab CI
Azure DevOps

# .github/workflows/release.yml
name: SDL Release
on:
  push:
    branches: [main]
    paths:
      - 'schema/**'

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Deploy SDL
        uses: bytebase/sql-review-action@v1
        with:
          command: rollout
          bytebase-url: ${{ secrets.BYTEBASE_URL }}
          bytebase-token: ${{ secrets.BYTEBASE_SERVICE_ACCOUNT_TOKEN }}
          file-pattern: 'schema/**/*.sql'
          project: projects/my-project
          targets: instances/prod/databases/mydb
          declarative: true

# .gitlab-ci.yml
sdl-rollout:
  image: bytebase/bytebase-action:cloud
  stage: deploy
  only:
    - main
  script:
    - |
      bytebase-action rollout \
        --url $BYTEBASE_URL \
        --service-account $BYTEBASE_SERVICE_ACCOUNT \
        --service-account-secret $BYTEBASE_SERVICE_ACCOUNT_SECRET \
        --file-pattern "schema/**/*.sql" \
        --project projects/my-project \
        --targets instances/prod/databases/mydb \
        --declarative

# azure-pipelines.yml
jobs:
  - job: SDLRelease
    pool:
      vmImage: 'ubuntu-latest'
    steps:
      - task: Docker@2
        inputs:
          command: run
          arguments: >
            bytebase/bytebase-action:cloud
            rollout
            --file-pattern "/workspace/schema/**/*.sql"
            --project projects/my-project
            --targets instances/prod/databases/mydb
            --declarative

Version Management

SDL automatically generates versions using timestamp format YYYYMMDD.HHMMSS:

Release 2025-01-15 10:30:00 → Version: 20250115.103000
Release 2025-01-20 14:15:00 → Version: 20250120.141500

All files in a release share the same version. Bytebase compares this version with the latest revision to determine if deployment is needed.

Migration Generation Example

PostgreSQL
MySQL

Current Database:

CREATE TABLE public.users (
    id INTEGER PRIMARY KEY,
    username TEXT NOT NULL
);

New SDL:

CREATE TABLE public.users (
    id INTEGER,
    username TEXT NOT NULL,
    email TEXT NOT NULL,
    CONSTRAINT users_pkey PRIMARY KEY (id),
    CONSTRAINT users_email_key UNIQUE (email)
);

CREATE INDEX idx_users_email ON public.users(email);

Generated Migration:

-- Bytebase automatically generates:
ALTER TABLE public.users ADD COLUMN email TEXT NOT NULL;
ALTER TABLE public.users ADD CONSTRAINT users_email_key UNIQUE (email);
CREATE INDEX idx_users_email ON public.users(email);

Current Database:

CREATE TABLE `users` (
  `id` int NOT NULL,
  `username` varchar(64) NOT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

New SDL:

CREATE TABLE `users` (
  `id` int NOT NULL,
  `username` varchar(64) NOT NULL,
  `email` varchar(255) NOT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `uk_users_email` (`email`),
  KEY `idx_users_username` (`username`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

Generated Migration:

-- Bytebase automatically generates:
ALTER TABLE `users` ADD COLUMN `email` varchar(255) NOT NULL;
ALTER TABLE `users` ADD UNIQUE KEY `uk_users_email` (`email`);
ALTER TABLE `users` ADD KEY `idx_users_username` (`username`);

Database CI/CD

UI-Driven Workflow

GitOps Workflow

Appendix

How SDL Release Works

CI/CD Integration

Version Management

Migration Generation Example

Next Steps

Limitations

Best Practices

​How SDL Release Works

​CI/CD Integration

​Version Management

​Migration Generation Example

​Next Steps

Limitations

Best Practices

How SDL Release Works

CI/CD Integration

Version Management

Migration Generation Example

Next Steps