← Browse the extensions catalog

pglinter

Source README ↗

pglinter

pglinter checks PostgreSQL databases for schema design and configuration problems, including missing primary keys, redundant indexes, and missing indexes on foreign keys. These images support PostgreSQL 18 on Debian Bookworm and Trixie.

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 pglinter extension image to your Cluster

Define the pglinter extension under the postgresql.extensions section of your Cluster resource. For example:

apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
  name: cluster-pglinter
spec:
  imageCatalogRef: ...
  postgresql:
    extensions:
    - name: pglinter

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

Once the database is ready, connect to it with psql and run:

SELECT * FROM pglinter.get_violations();

The query returns findings from the enabled lint rules.

Extension and dependency licenses and copyright notices are bundled in /licenses/ in the image.