Documentation

Quick Start

Get started with MigrationPilot in under 2 minutes.

Configuration

Configure MigrationPilot with a YAML config file or package.json.

GitHub Action

Run MigrationPilot as a GitHub Action to catch unsafe migrations in pull requests.

CI Integration

Integrate MigrationPilot with GitHub Actions, GitLab CI, Bitbucket Pipelines, and other CI systems.

Programmatic API

Use MigrationPilot as a library in your Node.js applications.

CLI Reference

Complete reference for all MigrationPilot CLI commands and options.

Rule catalogue

Every rule with its severity, the lock it warns about, before-and-after SQL, and whether --fix can apply it for you.

Migration Safety Handbook

Twenty chapters on why these changes hurt, each measured against a real PostgreSQL rather than argued from the manual.

TypeScript / JavaScript

Prisma

Prisma uses declarative schema files and generates SQL migrations via prisma migrate.

Python

Django

Django generates Python migration files that execute SQL. Use sqlmigrate to extract the SQL.

JavaScript

Knex.js

Knex.js uses JavaScript migration files. Write raw SQL migrations for best results.

TypeScript / JavaScript

TypeORM

TypeORM generates migration files with up/down methods. Use query logging to extract SQL.

TypeScript

Drizzle ORM

Drizzle generates SQL migration files via drizzle-kit.

JavaScript

Sequelize

Sequelize uses JavaScript migration files with queryInterface methods.

Ruby

Ruby on Rails

Rails Active Record migrations are Ruby files. Extract SQL with schema statements.

Elixir

Ecto (Elixir)

Ecto migrations are Elixir modules. Use raw SQL execute statements for best results.

SQL

Flyway

Flyway uses versioned SQL migration files (V1__description.sql). Perfect fit for MigrationPilot.

SQL / XML / YAML

Liquibase

Liquibase supports multiple changelog formats. Use SQL changelogs for best results.

Python

Alembic

Alembic migrations are Python files. Use alembic upgrade --sql to extract SQL.

Go / SQL

goose

goose uses SQL or Go migration files. SQL migrations work directly with MigrationPilot.

SQL

dbmate

dbmate uses plain SQL migration files. Perfect fit for MigrationPilot.

SQL

Sqitch

Sqitch uses change-based SQL migration scripts organized in deploy/revert/verify directories.