Skip to content

INSTALL.md

Latest commit

 

History

History
90 lines (64 loc) · 2.53 KB

INSTALL.md

File metadata and controls

90 lines (64 loc) · 2.53 KB
Raw

INSTALL

PGXN / source install

pgRDF ships PGXN metadata at the repository root:

  • META.json
  • Makefile
  • README.pgxn.md
  • LICENSE

The PGXN build path is source-based. It shells out to cargo pgrx package, so the build host needs the Rust and pgrx toolchain in addition to PostgreSQL.

Prebuilt binary artifacts remain on the GitHub Releases page as the existing pgrdf-<version>-pg<PG_MAJOR>-glibc-<arch>.tar.gz matrix plus SHA256SUMS. The PGXN archive is the source distribution, not a replacement for those per-architecture binaries.

Prerequisites

  • PostgreSQL 14, 15, 16, or 17 development installation
  • pg_config for the target PostgreSQL major
  • Rust 1.91 or newer
  • cargo-pgrx 0.16
  • one-time cargo pgrx init for the target PostgreSQL installation

Example one-time pgrx setup:

cargo install cargo-pgrx --locked --version '^0.16'
cargo pgrx init --pg17 /path/to/pg_config

Install via PGXN client

pgxn install pgrdf --pg_config /path/to/pg_config

If you prefer to build directly from the unpacked PGXN source archive:

make PG_CONFIG=/path/to/pg_config
make PG_CONFIG=/path/to/pg_config install

Either path installs the extension files (pgrdf.so, pgrdf.control, the SQL). Do not run CREATE EXTENSION pgrdf yet — first complete the required configuration below.

Required PostgreSQL configuration

pgRDF must be in shared_preload_libraries: its _PG_init() registers the shared-memory dictionary cache and plan-cache atomics in the postmaster, which only happens at server startup. Without this, CREATE EXTENSION succeeds but the first pgRDF function call panics with PgAtomic was not initialized.

  1. Add pgrdf to shared_preload_libraries in postgresql.conf:

    shared_preload_libraries = 'pgrdf'

  2. Restart the server (a reload is not enough — preload happens at postmaster startup):

    pg_ctl restart -D /path/to/your/PGDATA      # or: systemctl restart postgresql

  3. Verify, then create the extension:

    psql -d yourdb -c "SHOW shared_preload_libraries;"   -- must contain 'pgrdf'
psql -d yourdb -c 'CREATE EXTENSION pgrdf;'
psql -d yourdb -c "SELECT pgrdf.version();"

Maintainer release artifact

Build the PGXN-ready source archive from a tagged commit:

make dist

This emits pgrdf-<version>.zip, with the standard pgrdf-<version>/... directory prefix expected by PGXN Manager. The GitHub release workflow also attaches this zip alongside the existing binary tarballs.