← Browse the extensions catalog

jsquery

Source README ↗

jsquery

Adds the jsquery language and GIN indexing support for searching jsonb values. See the upstream project for its API and release history.

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

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

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.

A SQL check that exercises the installed extension is:

SELECT '{"a": 1}'::jsonb @@ 'a = 1'::jsquery;

Package, dependencies and maintenance

The image installs PGDG package postgresql-18-jsquery at the Debian version recorded in metadata.hcl. Package updates are tracked by Renovate; review changes against the package's control file and rerun the target's build. The package is available for PostgreSQL 18 on both Bookworm and Trixie, amd64 and arm64. It depends on the CNPG PostgreSQL 18 base image and libc; no additional runtime package is installed. The jsquery module uses PostgreSQL licensing. Its Debian copyright file, including upstream attribution and any bundled component notices, is included under /licenses/.

The SQL catalog version is maintained separately from the Debian package version; verify default_version in the packaged control file when updating the package.