Skip to main content

image image image Documentation

Generate migrations between Postgres databases.

Use pgmig to compare the structure of two Postgres databases — a source and a target — and generate the SQL that turns the source into the target.

pgmig connects read-only to both databases and never runs the generated SQL for you: you review it and apply it yourself.

pgmig officially supports Postgres 14–18 — the majors currently maintained upstream — and is tested against each in CI. Other versions may work but are not tested.

Documentation: pgmig.readthedocs.io

Quick start

Say the current database has a users table, and the desired one adds an email column with a unique index:

-- current
CREATE TABLE users (id bigint PRIMARY KEY, name text NOT NULL);

-- desired
CREATE TABLE users (id bigint PRIMARY KEY, name text NOT NULL, email text NOT NULL);
CREATE UNIQUE INDEX users_email_idx ON users (email);

Print the migration SQL that makes current match desired, using uvx:

$ uvx pgmig generate \
    --source postgresql://user:pass@localhost:5432/current \
    --target postgresql://user:pass@localhost:5432/desired

ALTER TABLE "public"."users" ADD COLUMN "email" text NOT NULL;
CREATE UNIQUE INDEX users_email_idx ON public.users USING btree (email);

Or from Python:

import pgmig

sql = pgmig.generate(
    source="postgresql://user:pass@localhost:5432/current",
    target="postgresql://user:pass@localhost:5432/desired",
)

print(sql)
# ALTER TABLE "public"."users" ADD COLUMN "email" text NOT NULL;
# CREATE UNIQUE INDEX users_email_idx ON public.users USING btree (email);

Contributing

Contributions are welcome!

See CONTRIBUTING.md for details.

License

pgmig is distributed under the terms of the MIT license.

Metadata

Release files for pgmig 1.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pgmig 1.1.3
File Size Uploaded Provenance Actions
pgmig-1.1.3.tar.gz 779.8 kB Without provenance Details for pgmig-1.1.3.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pgmig 1.1.3
File Interpreter ABI Platform Actions
pgmig-1.1.3-py3-none-any.whl Python 3 none any Details for pgmig-1.1.3-py3-none-any.whl

Total release size: 921.6 kB

Release files / pgmig-1.1.3.tar.gz

Download URL pgmig-1.1.3.tar.gz
Size 779.8 kB
Tags Source
SHA-256 checksum
How to use checksums
09e9fb638eaaa96dcacd949033e9cb08fe5c758410684b12f772bdb58a45206f
BLAKE2b-256 checksum
How to use checksums
85ec50528187d56e1c34189401089b677037282b75442edaab7d16180f3b9662
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / pgmig-1.1.3-py3-none-any.whl

Download URL pgmig-1.1.3-py3-none-any.whl
Size 141.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
089bc9ec7d468bd56cffd0457450f4db2d4db6cd03a94ca764114b0edaad01b4
BLAKE2b-256 checksum
How to use checksums
547ae3b4b2eaf8bfa4508bf29e09bf47adeb292a3569f03bcca2440001b48f5a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for pgmig 1.1.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page