← Browse the extensions catalog

pgsphere

Source README ↗

pgSphere

pgSphere is a PostgreSQL extension that provides spherical geometry data types and operators for astronomical and geographical data. It supports types such as spherical points, circles, ellipses, lines, polygons, and boxes, along with indexing via GiST.

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

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

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

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:

\dx

You should see pg_sphere listed among the installed extensions.

Known Caveats

  • Runtime library dependency: This extension requires HEALPIX and other astronomical libraries at runtime. These are bundled in the image under /system/.
  • License: pgsphere is GPL-3+, which is why it is hosted in the CNPG Extensions project rather than upstream.

This container image contains software that may be licensed under various open-source licenses.

All relevant license and copyright information for the pgsphere extension and its dependencies are bundled within the image at:

/licenses/

By using this image, you agree to comply with the terms of the licenses contained therein.