跳转到主要内容

pg_readme_test_extension

Fixture extension used to test pg_readme document generation

pg_readme : Fixture extension used to test pg_readme document generation

Overview

ID Extension Package Version Category License Language
4301 pg_readme_test_extension pg_readme 0.7.1 UTIL PostgreSQL SQL
Attribute Has Binary Has Library Need Load Has DDL Relocatable Trusted
----d-r No No No Yes yes no
Relationships
See Also pg_readme schedoc ddlx pgpdf pg_render pgdd meta
Siblings pg_readme
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.

Packages

Type Repo Version PG Major Compatibility Package Pattern Dependencies
EXT MIXED 0.7.1 18 17 16 15 14 pg_readme -
RPM PGDG 0.7.0 18 17 16 15 14 pg_readme_$v -
DEB PIGSTY 0.7.1 18 17 16 15 14 postgresql-$v-pg-readme -
Linux / PG PG18 PG17 PG16 PG15 PG14
el8.x86_64 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0
el8.aarch64 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0
el9.x86_64 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0
el9.aarch64 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0
el10.x86_64 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0
el10.aarch64 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0 PGDG 0.7.0
d12.x86_64 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1
d12.aarch64 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1
d13.x86_64 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1
d13.aarch64 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1
u22.x86_64 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1
u22.aarch64 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1
u24.x86_64 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1
u24.aarch64 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1
u26.x86_64 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1
u26.aarch64 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1 PIGSTY 0.7.1

Source

Repository

github.com/bigsmoke/pg_readme/tree/master/pg_readme_test_extension

pig build pkg pg_readme;		# build deb

Install

Make sure PGDG and PIGSTY repo available:

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

Install this extension with pig:

pig install pg_readme;		# install via package name, for the active PG version
pig install pg_readme_test_extension;		# install by extension name, for the current active PG version

pig install pg_readme_test_extension -v 18;   # install for PG 18
pig install pg_readme_test_extension -v 17;   # install for PG 17
pig install pg_readme_test_extension -v 16;   # install for PG 16
pig install pg_readme_test_extension -v 15;   # install for PG 15
pig install pg_readme_test_extension -v 14;   # install for PG 14

Create this extension with:

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.