← Browse the extensions catalog

pg-rewrite

Source README ↗

pg_rewrite

Rewrite PostgreSQL tables with less locking. Upstream documentation.

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.

Supported images

PostgreSQL 18; Debian Trixie and Bookworm; amd64 and arm64 build targets.

Usage

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

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: cluster-pg-rewrite
spec:
  imageCatalogRef: ...
  postgresql:
    shared_preload_libraries:
    - pg_rewrite
    parameters:
      wal_level: logical
      output_plugin_libraries: pgoutput,test_decoding,pg_rewrite
    extensions:
    - name: pg-rewrite

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.

3. Verify installation

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

Operation and privileges

Table rewriting needs logical WAL and a free replication slot. Ensure sufficient CNPG data-volume space for both table copies and retained WAL. Remove the old table with SQL after verification; inspect and remove any abandoned inactive replication slots after a failed operation.

Dependencies and updates

The image contains only the PGDG package server payload and license notices. The matching CNPG minimal image supplies PostgreSQL, libc and its base runtime. Project automation tracks package updates and rebuilds the extension images. Use the catalog maintenance schedule in the quick start to consume published PostgreSQL and extension image updates. Monitor pending SQL extension upgrades and review them separately; SQL versions need not match package versions.

Licenses and ownership

PostgreSQL. Redistribution notices are preserved under /licenses/.

The PGDG copyright labels its notice(s) cybertec. The permission and disclaimer text matches the SPDX PostgreSQL license template, which allows copyright-holder substitutions in the disclaimer paragraphs. The metadata uses that SPDX identifier; the image retains the complete original package copyright, including every named holder and notice.