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.
1 maintainer
Metadata
1 maintainer
Release files for pgmig 1.0.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| pgmig-1.0.8.tar.gz | 761.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pgmig-1.0.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 899.6 kB
Release files / pgmig-1.0.8.tar.gz
| Download URL | pgmig-1.0.8.tar.gz |
|---|---|
| Size | 761.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
be7001a1bb14829fc1ad6b3e52ea5488c9f2eb5de9ca8e32231c9aecb26e7dbe
|
|
BLAKE2b-256 checksum How to use checksums |
d993a06a1eabe62999c38fa180ec53a3a18be8a4cabd762a3712ffe0836da01f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / pgmig-1.0.8-py3-none-any.whl
| Download URL | pgmig-1.0.8-py3-none-any.whl |
|---|---|
| Size | 137.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5048facb361059d7574772f6647992946dbbc912e844fc379de0abd5ac785617
|
|
BLAKE2b-256 checksum How to use checksums |
c36b3105eace1dcd85393474ed47aa7b5c8348278428d246541df80a44deac04
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for pgmig 1.0.8
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.
