← Browse the extensions catalog

pg-partman

Source README ↗

pg-partman

pg_partman creates and maintains time-based and ID-based PostgreSQL partition sets. Its optional background worker can run partition maintenance automatically.

Follow the quick start to set up extension-update email alerts first, then use the CronJob to install and refresh the catalog. These examples inherit image references and runtime settings from the catalog. The Cluster YAML is an excerpt: replace imageCatalogRef: ... with your catalog reference and keep your existing instance and storage settings.

Usage

1. Add the pg-partman extension image to your Cluster

Add the image to a Cluster and preload the background worker:

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: cluster-pg-partman
spec:
  imageCatalogRef: ...
  postgresql:
    shared_preload_libraries:
    - pg_partman_bgw
    extensions:
    - name: pg-partman

2. Enable the extension in a database

Once the extension's files are available in the cluster, you can install it in a database in either of two ways:

Platform teams may make extension containers available across their clusters without installing every extension in every database. Install only the extensions a database uses; letting users enable them through SQL alongside the rest of their DDL schema management code can be a convenient approach.

For extensions that normally require superuser privileges, platform teams can use pgextwlist to allow non-superusers to install an administrator-approved selection of extensions.

For pg_partman, create the partman schema first and use CREATE EXTENSION pg_partman SCHEMA partman;, or set schema: partman in the declarative extension entry.

3. Verify installation

Connect to the database with psql and run \dx to check the installed extensions.

See the pg_partman documentation for partition-set configuration examples.

The package copyright and license notice are included in the image under /licenses/postgresql-18-partman/.