pgpartix#
pgpartix generates reviewable PostgreSQL partition-lifecycle migrations. Users can commit them locally, integrate them with any CI/CD or scheduling environment, or use the optional GitHub pull-request helper.
Start here#
- Getting started - install the container, prepare a schema catalog, and generate the first migrations.
- Configuration reference - configure partition creation, expiration, naming, templates, storage, and table overrides.
- Optional GitHub Actions automation - run reconciliation on a GitHub schedule and create PRs through a dedicated GitHub App.
Reference#
- CLI reference - commands, environment variables, exit behavior, and examples.
- Annotated configuration - a complete configuration using the current schema.
- Generated JSON Schema reference - machine-derived option documentation.
- Contributing - development environment, testing, and contribution workflow.
Documentation boundaries#
Each guide has one purpose:
| Guide | Use it when |
|---|---|
| Getting started | You are evaluating or installing pgpartix. |
| Configuration | You need to understand or change lifecycle behavior. |
| GitHub Actions | You want the optional scheduled GitHub PR workflow. |
| CLI reference | You need command syntax, environment requirements, or failure semantics. |