Skip to content
pgmold

Quick Start

1. Create a schema file

Section titled “1. Create a schema file”
-- schema.sql
CREATE TABLE users (
    id BIGINT PRIMARY KEY,
    email TEXT NOT NULL,
    created_at TIMESTAMP DEFAULT now()
);

2. See what would change

Section titled “2. See what would change”
Terminal window
pgmold plan -s sql:schema.sql -d postgres://localhost/mydb

This compares your SQL file against the live database and shows the migration plan.

3. Apply the migration

Section titled “3. Apply the migration”
Terminal window
pgmold apply -s sql:schema.sql -d postgres://localhost/mydb

All operations run in a single transaction. If anything fails, nothing changes.

4. Detect drift

Section titled “4. Detect drift”
Terminal window
pgmold drift -s sql:schema.sql -d postgres://localhost/mydb --json

Returns exit code 1 if the database has drifted from your schema files. Use this in CI.

Next steps

Section titled “Next steps”