Database-migration safety gate for Python — Django, Alembic, and raw SQL, with AI blast-radius judgment
Project description
Oneport Migrate
The database-migration safety gate for Python teams. Django migrations,
Alembic revisions, and raw .sql — checked by a deterministic rule engine,
judged by an LLM that knows your repo, and wired into CI as a blocking gate.
Migrations are the scariest deploy moment: squawk lints Postgres SQL only,
strong_migrations is Rails only. Nothing covers the Python world's actual
migration formats. Oneport Migrate does.
How it works
Two layers, strictly separated:
-
Deterministic rule engine — parses your migrations (Django via AST, Alembic via AST, raw SQL via regex) into a normalized operation model and matches it against a YAML rule catalog (
OPM001+). This layer alone decides whether an operation is dangerous. No model, no network, no flakiness — the same migration always produces the same findings. -
LLM blast-radius layer (Gemini or Claude) — given the findings, the migration source, and your models/schema files, it judges how dangerous in this repo ("the
userstable is written on every request — a 4-minute lock here is an outage"), writes a safe multi-step rewrite plan (expand → backfill in batches → contract), and a plain-English verdict. It can adjust a finding's severity only when your team guidelines explicitly justify it — never on its own judgment.
If the LLM is unavailable (no key, rate limit, bad output), the gate still works: deterministic findings and the exit code stand on their own.
Install
pip install oneport-migrate
export GEMINI_API_KEY=... # free at https://aistudio.google.com/apikey
Claude instead of Gemini: pip install oneport-migrate[claude] and set
ANTHROPIC_API_KEY.
Usage
# One file, a directory, git state, or a PR
oneport-migrate check app/migrations/0042_drop_legacy.py
oneport-migrate check migrations/
oneport-migrate check --staged
oneport-migrate check --head
oneport-migrate check https://github.com/org/repo/pull/42
# Post findings as an inline PR review (requires GITHUB_TOKEN)
oneport-migrate check https://github.com/org/repo/pull/42 --post
# Options
oneport-migrate check migrations/ --db mysql --format json --min-severity error
oneport-migrate check migrations/ --no-llm # deterministic rules only
oneport-migrate rules list
Exit codes (the CI contract)
| Code | Meaning |
|---|---|
| 0 | clean, or warnings/info only |
| 1 | blocking findings (error/critical) |
| 2 | usage / config / auth error |
Blocking is computed from the full finding set before any display
filtering — --min-severity critical can hide an error from the output, but
never from the exit code.
Rule catalog
| ID | Severity | What it catches |
|---|---|---|
| OPM001 | critical | Dropping a column |
| OPM002 | critical | Dropping a table |
| OPM003 | critical | TRUNCATE / DELETE without WHERE |
| OPM010 | error | ALTER COLUMN TYPE (table rewrite under exclusive lock) |
| OPM011 | error | Adding a NOT NULL column without a default |
| OPM012 | error | CREATE INDEX without CONCURRENTLY (Postgres only) |
| OPM013 | error | Adding NOT NULL to an existing column |
| OPM020 | warning | Missing reverse migration (reverse_code / downgrade / reverse_sql) |
| OPM021 | error | Data migration inside a schema transaction |
| OPM030 | warning | Column rename (breaks rolling deploys) |
| OPM031 | warning | Table rename (breaks rolling deploys) |
Indexes on tables created in the same migration are exempt from OPM012 (the
table is empty). OPM012 only fires for --db postgres.
Project config — .oneportmigraterc
db: postgres
rules:
ignore: [OPM031]
severity:
OPM012: warning # deterministic override, applies before the LLM runs
output:
format: inline
min_severity: warning
Team guidelines — .oneport/guidelines.md
The same file oneport-review uses. The LLM reads it and may downgrade or upgrade a finding's severity only when an entry explicitly covers it, quoting the guideline in its reason:
- our users table is small (<10k rows), downgrade lock severity
- the events table is 400M rows and append-only — never rewrite in place
Honest limits
- Raw SQL parsing is regex-based. Statements are split on
;without full string-literal awareness;$$-quoted function bodies and dynamic SQL (EXECUTE format(...)) are not analyzed. When the parser hits these it attaches a note to the output instead of guessing. Misses are false negatives — it never invents a finding. - Django
AlterField/ Alembicalter_column(type_=...): a single migration file doesn't show the old column definition, so every field alteration is flagged as a potential rewrite. You (or the LLM, with repo context) decide if it's actually a no-op. RunSQL/op.executewith non-literal arguments (variables, f-strings) can't be inspected — recorded as unanalyzed raw SQL with a note.- Table sizes are unknown to the rule engine. "Large-table" judgment is exactly what the LLM layer is for; without an API key you get the deterministic worst-case severities.
--staged/--headread file contents from the working tree.
CI
See examples/workflows/migrate-gate.yml:
- run: pip install oneport-migrate
- run: oneport-migrate check --head --post "$PR_URL"
env:
GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
--post submits one inline PR review per revision; a hidden marker in the
review body prevents duplicate reviews when CI re-runs on the same commit.
Privacy
Serverless: your migration files go directly from your machine/CI to the model API using your key. No Oneport server ever sees your code. See PRIVACY.md.
Part of the Oneport suite
- oneport-review — CodeRabbit-class AI code review
- oneport-migrate — this tool
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file oneport_migrate-0.1.0.tar.gz.
File metadata
- Download URL: oneport_migrate-0.1.0.tar.gz
- Upload date:
- Size: 45.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
257e8ccaf3ab04a7bf302a4098dda8e4166bef91a021a4e62f2596a12da08eb2
|
|
| MD5 |
f0a32aa09c6f30299e2feebf5b5b2d63
|
|
| BLAKE2b-256 |
49c3dcbf5132719dc08082e709bb01a3eb3eb2f196eb78d06ab60ffbd7e384af
|
File details
Details for the file oneport_migrate-0.1.0-py3-none-any.whl.
File metadata
- Download URL: oneport_migrate-0.1.0-py3-none-any.whl
- Upload date:
- Size: 54.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
71535cfc2c4e0e42c187adb226da4a38ba38a8e1b7de96008724ea39167a832e
|
|
| MD5 |
041e9464c728970489f34035c59a7d86
|
|
| BLAKE2b-256 |
cdbe27b05f89ee14df5daca75a5662e7a225514fa0251bd9a3ec3b2f2da18d6b
|