Set up Squawk to catch unsafe PostgreSQL migrations before they reach production.
BeforeMerge offers hundreds of code review rules, guides, and detection patterns to help your team ship better code.
Squawk is a static analysis tool for PostgreSQL migration files. It catches operations that cause table locks, downtime, or data loss — before you run them.
# Via pip (recommended for CI)
pip install squawk-cli
# Via brew
brew install squawk
# Via npm (check platform support)
npm install -D squawk-cli# Lint a single migration
squawk path/to/migration.sql
# Lint all migrations
squawk migrations/*.sql
# With config file
squawk --config .squawk.toml migrations/*.sql# Exclude rules that don't apply
excluded_rules = [
"prefer-robust-stmts",
"require-timeout-settings",
]
# Target Postgres version
pg_version = "17.0"| Rule | Severity | What It Catches |
|---|---|---|
require-concurrent-index-creation |
WARN | CREATE INDEX without CONCURRENTLY |
adding-not-nullable-field |
WARN | ALTER TABLE ADD COLUMN NOT NULL |
adding-field-with-default |
WARN | Adding column with volatile default |
prefer-bigint-over-int |
WARN | Using int instead of bigint |
ban-drop-column |
ERROR | Dropping columns (data loss) |
ban-drop-table |
ERROR | Dropping tables (data loss) |
require-timeout-settings |
WARN | Missing lock_timeout/statement_timeout |
db-lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- run: pip install squawk-cli
- run: squawk --config packages/db/.squawk.toml packages/db/supabase/migrations/*.sql- name: Lint changed migrations
if: github.event_name == 'pull_request'
run: |
CHANGED=$(git diff --name-only origin/main -- 'packages/db/supabase/migrations/*.sql')
if [ -n "$CHANGED" ]; then
squawk --config packages/db/.squawk.toml $CHANGED
fi