Skip to content

pg_readme_test_extension

Fixture extension used to test pg_readme document generation

Overview

PackageVersionCategoryLicenseLanguage
pg_readme0.7.1UTILPostgreSQLSQL
IDExtensionBinLibLoadCreateTrustRelocSchema
4300pg_readmeNoNoNoYesNoYes-
4301pg_readme_test_extensionNoNoNoYesNoYes-

Bundled test fixture; its control default_version is forever and it does not require hstore; package ownership follows pg_readme: PGDG RPM 0.7.0 and PIGSTY DEB 0.7.1.

Version

TypeRepoVersionPG VerPackageDeps
EXTMIXED0.7.11817161514pg_readme-
RPMPGDG0.7.01817161514pg_readme_$v-
DEBPIGSTY0.7.11817161514postgresql-$v-pg-readme-
OS / PGPG18PG17PG16PG15PG14
el8.x86_64PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0
el8.aarch64PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0
el9.x86_64PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0
el9.aarch64PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0
el10.x86_64PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0
el10.aarch64PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0PGDG 0.7.0
d12.x86_64PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1
d12.aarch64PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1
d13.x86_64PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1
d13.aarch64PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1
u22.x86_64PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1
u22.aarch64PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1
u24.x86_64PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1
u24.aarch64PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1
u26.x86_64PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1
u26.aarch64PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1PIGSTY 0.7.1

Build

You can build the DEB packages for pg_readme using pig build:

pig build pkg pg_readme         # build DEB packages

Install

You can install pg_readme directly. First, make sure the PGDG and PIGSTY repositories are added and enabled:

pig repo add pgsql -u          # Add repo and update cache

Install the extension using pig or apt/yum/dnf:

Install
pig install pg_readme;          # Install for current active PG version
pig
pig ext install -y pg_readme -v 18  # PG 18
pig ext install -y pg_readme -v 17  # PG 17
pig ext install -y pg_readme -v 16  # PG 16
pig ext install -y pg_readme -v 15  # PG 15
pig ext install -y pg_readme -v 14  # PG 14
dnf
dnf install -y pg_readme_18       # PG 18
dnf install -y pg_readme_17       # PG 17
dnf install -y pg_readme_16       # PG 16
dnf install -y pg_readme_15       # PG 15
dnf install -y pg_readme_14       # PG 14
apt
apt install -y postgresql-18-pg-readme   # PG 18
apt install -y postgresql-17-pg-readme   # PG 17
apt install -y postgresql-16-pg-readme   # PG 16
apt install -y postgresql-15-pg-readme   # PG 15
apt install -y postgresql-14-pg-readme   # PG 14

Create Extension:

CREATE EXTENSION pg_readme_test_extension;

Usage

Sources:

pg_readme_test_extension is the bundled integration-test fixture for pg_readme. It installs commented domains, types, tables, views, routines, triggers, and processing instructions so upstream can verify pg_extension_readme(). It is not an application feature or a production dependency.

Exercise the Fixture

CREATE EXTENSION pg_readme CASCADE;
CREATE EXTENSION pg_readme_test_extension;

SELECT pg_extension_readme('pg_readme_test_extension'::name);

Use the output to test or demonstrate the generator, then remove the fixture from a disposable database:

DROP EXTENSION pg_readme_test_extension;

Boundary and Caveats

  • The upstream distribution version is 0.7.1, but this fixture’s control version is deliberately the literal forever.
  • The fixture ships with pg_readme; current Pigsty DEB packages are 0.7.1 and RPM packages remain 0.7.0. The extension version stays forever on both sides.
  • It is relocatable, does not require hstore itself, and creates sample objects with generic names. Install it only where those objects cannot collide with real application schemas.
  • Its SQL surface exists to cover generator behavior and can change as tests evolve. Do not build application code against the fixture objects.

Was this page helpful?