Skip to main content
Automated SQL review validates your migration files during pull/merge requests, catching issues before they reach production.

What Gets Validated

Automated checks include:
  • SQL syntax validation
  • Policy rule enforcement (200+ configurable rules)
  • Naming convention compliance
  • Risk assessment for dangerous operations
  • Schema compatibility checks

SQL Review Policy

Configure 200+ linting rules for automated validation

Setup

Prerequisites:
  1. Set up SQL Review Policy - Define your SQL standards
  2. Install GitOps Integration - Connect Bytebase to your VCS

CI/CD Integration Examples

  • GitHub Actions
  • GitLab CI
  • Azure DevOps
  • Bitbucket Pipelines
# .github/workflows/sql-review.yml
name: SQL Review
on:
  pull_request:
    paths:
      - 'migrations/**'

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

      - name: SQL Review
        uses: bytebase/sql-review-action@v1
        with:
          bytebase-url: ${{ secrets.BYTEBASE_URL }}
          bytebase-token: ${{ secrets.BYTEBASE_SERVICE_ACCOUNT_TOKEN }}
          file-pattern: 'migrations/**/*.sql'

GitHub Tutorial

GitHub Example

GitHub PR SQL Review

Review Bot Feedback

The SQL review bot posts detailed feedback as PR/MR comments:
  • Passed checks - Migration meets all policy requirements
  • ⚠️ Warnings - Best practice violations (non-blocking by default)
  • Errors - Policy violations (blocking by default)
  • 📊 Risk assessment - Evaluation of potential impact
  • 📝 Detailed explanations - Why rules failed with fix suggestions

Next Steps