schedoc

Cross documentation between Django and DBT projects

Overview

Package	Version	Category	License	Language
`pg_schedoc`	`0.0.1`	UTIL	GPL-3.0	SQL

ID	Extension	Bin	Lib	Load	Create	Trust	Reloc	Schema
4330	`schedoc`	No	No	No	Yes	No	No	-

Related	`ddl_historization` `pg_readme` `ddlx` `pg_render` `pgpdf` `pgdd` `meta` `pg_get_functiondef` `pg_dbms_metadata` `pg_catcheck` `pg_query_rewrite`

Version

Type	Repo	Version	PG Ver	Package	Deps
EXT	PIGSTY	`0.0.1`	1817161514	`pg_schedoc`	`ddl_historization`
RPM	PIGSTY	`0.0.1`	1817161514	`pg_schedoc_$v`	`ddl_historization_$v`
DEB	PIGSTY	`0.0.1`	1817161514	`postgresql-$v-pg-schedoc`	`postgresql-$v-ddl-historization`

OS / PG	PG18	PG17	PG16	PG15	PG14
el8.x86_64	PIGSTY 0.0.1 el8.x86_64.pg18 : pg_schedoc_18 pg_schedoc_18-0.0.1-1PIGSTY.el8.x86_64.rpm PIGSTY · 0.0.1 · 22.9KiB	PIGSTY 0.0.1 el8.x86_64.pg17 : pg_schedoc_17 pg_schedoc_17-0.0.1-1PIGSTY.el8.x86_64.rpm PIGSTY · 0.0.1 · 22.9KiB	PIGSTY 0.0.1 el8.x86_64.pg16 : pg_schedoc_16 pg_schedoc_16-0.0.1-1PIGSTY.el8.x86_64.rpm PIGSTY · 0.0.1 · 22.9KiB	PIGSTY 0.0.1 el8.x86_64.pg15 : pg_schedoc_15 pg_schedoc_15-0.0.1-1PIGSTY.el8.x86_64.rpm PIGSTY · 0.0.1 · 22.9KiB	PIGSTY 0.0.1 el8.x86_64.pg14 : pg_schedoc_14 pg_schedoc_14-0.0.1-1PIGSTY.el8.x86_64.rpm PIGSTY · 0.0.1 · 22.9KiB
el8.aarch64	PIGSTY 0.0.1 el8.aarch64.pg18 : pg_schedoc_18 pg_schedoc_18-0.0.1-1PIGSTY.el8.aarch64.rpm PIGSTY · 0.0.1 · 22.9KiB	PIGSTY 0.0.1 el8.aarch64.pg17 : pg_schedoc_17 pg_schedoc_17-0.0.1-1PIGSTY.el8.aarch64.rpm PIGSTY · 0.0.1 · 22.9KiB	PIGSTY 0.0.1 el8.aarch64.pg16 : pg_schedoc_16 pg_schedoc_16-0.0.1-1PIGSTY.el8.aarch64.rpm PIGSTY · 0.0.1 · 22.9KiB	PIGSTY 0.0.1 el8.aarch64.pg15 : pg_schedoc_15 pg_schedoc_15-0.0.1-1PIGSTY.el8.aarch64.rpm PIGSTY · 0.0.1 · 22.9KiB	PIGSTY 0.0.1 el8.aarch64.pg14 : pg_schedoc_14 pg_schedoc_14-0.0.1-1PIGSTY.el8.aarch64.rpm PIGSTY · 0.0.1 · 22.9KiB
el9.x86_64	PIGSTY 0.0.1 el9.x86_64.pg18 : pg_schedoc_18 pg_schedoc_18-0.0.1-1PIGSTY.el9.x86_64.rpm PIGSTY · 0.0.1 · 22.5KiB	PIGSTY 0.0.1 el9.x86_64.pg17 : pg_schedoc_17 pg_schedoc_17-0.0.1-1PIGSTY.el9.x86_64.rpm PIGSTY · 0.0.1 · 22.5KiB	PIGSTY 0.0.1 el9.x86_64.pg16 : pg_schedoc_16 pg_schedoc_16-0.0.1-1PIGSTY.el9.x86_64.rpm PIGSTY · 0.0.1 · 22.5KiB	PIGSTY 0.0.1 el9.x86_64.pg15 : pg_schedoc_15 pg_schedoc_15-0.0.1-1PIGSTY.el9.x86_64.rpm PIGSTY · 0.0.1 · 22.5KiB	PIGSTY 0.0.1 el9.x86_64.pg14 : pg_schedoc_14 pg_schedoc_14-0.0.1-1PIGSTY.el9.x86_64.rpm PIGSTY · 0.0.1 · 22.5KiB
el9.aarch64	PIGSTY 0.0.1 el9.aarch64.pg18 : pg_schedoc_18 pg_schedoc_18-0.0.1-1PIGSTY.el9.aarch64.rpm PIGSTY · 0.0.1 · 22.5KiB	PIGSTY 0.0.1 el9.aarch64.pg17 : pg_schedoc_17 pg_schedoc_17-0.0.1-1PIGSTY.el9.aarch64.rpm PIGSTY · 0.0.1 · 22.5KiB	PIGSTY 0.0.1 el9.aarch64.pg16 : pg_schedoc_16 pg_schedoc_16-0.0.1-1PIGSTY.el9.aarch64.rpm PIGSTY · 0.0.1 · 22.5KiB	PIGSTY 0.0.1 el9.aarch64.pg15 : pg_schedoc_15 pg_schedoc_15-0.0.1-1PIGSTY.el9.aarch64.rpm PIGSTY · 0.0.1 · 22.5KiB	PIGSTY 0.0.1 el9.aarch64.pg14 : pg_schedoc_14 pg_schedoc_14-0.0.1-1PIGSTY.el9.aarch64.rpm PIGSTY · 0.0.1 · 22.5KiB
el10.x86_64	PIGSTY 0.0.1 el10.x86_64.pg18 : pg_schedoc_18 pg_schedoc_18-0.0.1-1PIGSTY.el10.x86_64.rpm PIGSTY · 0.0.1 · 22.6KiB	PIGSTY 0.0.1 el10.x86_64.pg17 : pg_schedoc_17 pg_schedoc_17-0.0.1-1PIGSTY.el10.x86_64.rpm PIGSTY · 0.0.1 · 22.6KiB	PIGSTY 0.0.1 el10.x86_64.pg16 : pg_schedoc_16 pg_schedoc_16-0.0.1-1PIGSTY.el10.x86_64.rpm PIGSTY · 0.0.1 · 22.6KiB	PIGSTY 0.0.1 el10.x86_64.pg15 : pg_schedoc_15 pg_schedoc_15-0.0.1-1PIGSTY.el10.x86_64.rpm PIGSTY · 0.0.1 · 22.6KiB	PIGSTY 0.0.1 el10.x86_64.pg14 : pg_schedoc_14 pg_schedoc_14-0.0.1-1PIGSTY.el10.x86_64.rpm PIGSTY · 0.0.1 · 22.6KiB
el10.aarch64	PIGSTY 0.0.1 el10.aarch64.pg18 : pg_schedoc_18 pg_schedoc_18-0.0.1-1PIGSTY.el10.aarch64.rpm PIGSTY · 0.0.1 · 22.6KiB	PIGSTY 0.0.1 el10.aarch64.pg17 : pg_schedoc_17 pg_schedoc_17-0.0.1-1PIGSTY.el10.aarch64.rpm PIGSTY · 0.0.1 · 22.6KiB	PIGSTY 0.0.1 el10.aarch64.pg16 : pg_schedoc_16 pg_schedoc_16-0.0.1-1PIGSTY.el10.aarch64.rpm PIGSTY · 0.0.1 · 22.6KiB	PIGSTY 0.0.1 el10.aarch64.pg15 : pg_schedoc_15 pg_schedoc_15-0.0.1-1PIGSTY.el10.aarch64.rpm PIGSTY · 0.0.1 · 22.6KiB	PIGSTY 0.0.1 el10.aarch64.pg14 : pg_schedoc_14 pg_schedoc_14-0.0.1-1PIGSTY.el10.aarch64.rpm PIGSTY · 0.0.1 · 22.6KiB
d12.x86_64	PIGSTY 0.0.1 d12.x86_64.pg18 : postgresql-18-pg-schedoc postgresql-18-pg-schedoc_0.0.1-1PIGSTY~bookworm_amd64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d12.x86_64.pg17 : postgresql-17-pg-schedoc postgresql-17-pg-schedoc_0.0.1-1PIGSTY~bookworm_amd64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d12.x86_64.pg16 : postgresql-16-pg-schedoc postgresql-16-pg-schedoc_0.0.1-1PIGSTY~bookworm_amd64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d12.x86_64.pg15 : postgresql-15-pg-schedoc postgresql-15-pg-schedoc_0.0.1-1PIGSTY~bookworm_amd64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d12.x86_64.pg14 : postgresql-14-pg-schedoc postgresql-14-pg-schedoc_0.0.1-1PIGSTY~bookworm_amd64.deb PIGSTY · 0.0.1 · 4.5KiB
d12.aarch64	PIGSTY 0.0.1 d12.aarch64.pg18 : postgresql-18-pg-schedoc postgresql-18-pg-schedoc_0.0.1-1PIGSTY~bookworm_arm64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d12.aarch64.pg17 : postgresql-17-pg-schedoc postgresql-17-pg-schedoc_0.0.1-1PIGSTY~bookworm_arm64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d12.aarch64.pg16 : postgresql-16-pg-schedoc postgresql-16-pg-schedoc_0.0.1-1PIGSTY~bookworm_arm64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d12.aarch64.pg15 : postgresql-15-pg-schedoc postgresql-15-pg-schedoc_0.0.1-1PIGSTY~bookworm_arm64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d12.aarch64.pg14 : postgresql-14-pg-schedoc postgresql-14-pg-schedoc_0.0.1-1PIGSTY~bookworm_arm64.deb PIGSTY · 0.0.1 · 4.5KiB
d13.x86_64	PIGSTY 0.0.1 d13.x86_64.pg18 : postgresql-18-pg-schedoc postgresql-18-pg-schedoc_0.0.1-1PIGSTY~trixie_amd64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d13.x86_64.pg17 : postgresql-17-pg-schedoc postgresql-17-pg-schedoc_0.0.1-1PIGSTY~trixie_amd64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d13.x86_64.pg16 : postgresql-16-pg-schedoc postgresql-16-pg-schedoc_0.0.1-1PIGSTY~trixie_amd64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d13.x86_64.pg15 : postgresql-15-pg-schedoc postgresql-15-pg-schedoc_0.0.1-1PIGSTY~trixie_amd64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d13.x86_64.pg14 : postgresql-14-pg-schedoc postgresql-14-pg-schedoc_0.0.1-1PIGSTY~trixie_amd64.deb PIGSTY · 0.0.1 · 4.5KiB
d13.aarch64	PIGSTY 0.0.1 d13.aarch64.pg18 : postgresql-18-pg-schedoc postgresql-18-pg-schedoc_0.0.1-1PIGSTY~trixie_arm64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d13.aarch64.pg17 : postgresql-17-pg-schedoc postgresql-17-pg-schedoc_0.0.1-1PIGSTY~trixie_arm64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d13.aarch64.pg16 : postgresql-16-pg-schedoc postgresql-16-pg-schedoc_0.0.1-1PIGSTY~trixie_arm64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d13.aarch64.pg15 : postgresql-15-pg-schedoc postgresql-15-pg-schedoc_0.0.1-1PIGSTY~trixie_arm64.deb PIGSTY · 0.0.1 · 4.5KiB	PIGSTY 0.0.1 d13.aarch64.pg14 : postgresql-14-pg-schedoc postgresql-14-pg-schedoc_0.0.1-1PIGSTY~trixie_arm64.deb PIGSTY · 0.0.1 · 4.5KiB
u22.x86_64	PIGSTY 0.0.1 u22.x86_64.pg18 : postgresql-18-pg-schedoc postgresql-18-pg-schedoc_0.0.1-1PIGSTY~jammy_amd64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u22.x86_64.pg17 : postgresql-17-pg-schedoc postgresql-17-pg-schedoc_0.0.1-1PIGSTY~jammy_amd64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u22.x86_64.pg16 : postgresql-16-pg-schedoc postgresql-16-pg-schedoc_0.0.1-1PIGSTY~jammy_amd64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u22.x86_64.pg15 : postgresql-15-pg-schedoc postgresql-15-pg-schedoc_0.0.1-1PIGSTY~jammy_amd64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u22.x86_64.pg14 : postgresql-14-pg-schedoc postgresql-14-pg-schedoc_0.0.1-1PIGSTY~jammy_amd64.deb PIGSTY · 0.0.1 · 4.4KiB
u22.aarch64	PIGSTY 0.0.1 u22.aarch64.pg18 : postgresql-18-pg-schedoc postgresql-18-pg-schedoc_0.0.1-1PIGSTY~jammy_arm64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u22.aarch64.pg17 : postgresql-17-pg-schedoc postgresql-17-pg-schedoc_0.0.1-1PIGSTY~jammy_arm64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u22.aarch64.pg16 : postgresql-16-pg-schedoc postgresql-16-pg-schedoc_0.0.1-1PIGSTY~jammy_arm64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u22.aarch64.pg15 : postgresql-15-pg-schedoc postgresql-15-pg-schedoc_0.0.1-1PIGSTY~jammy_arm64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u22.aarch64.pg14 : postgresql-14-pg-schedoc postgresql-14-pg-schedoc_0.0.1-1PIGSTY~jammy_arm64.deb PIGSTY · 0.0.1 · 4.4KiB
u24.x86_64	PIGSTY 0.0.1 u24.x86_64.pg18 : postgresql-18-pg-schedoc postgresql-18-pg-schedoc_0.0.1-1PIGSTY~noble_amd64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u24.x86_64.pg17 : postgresql-17-pg-schedoc postgresql-17-pg-schedoc_0.0.1-1PIGSTY~noble_amd64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u24.x86_64.pg16 : postgresql-16-pg-schedoc postgresql-16-pg-schedoc_0.0.1-1PIGSTY~noble_amd64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u24.x86_64.pg15 : postgresql-15-pg-schedoc postgresql-15-pg-schedoc_0.0.1-1PIGSTY~noble_amd64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u24.x86_64.pg14 : postgresql-14-pg-schedoc postgresql-14-pg-schedoc_0.0.1-1PIGSTY~noble_amd64.deb PIGSTY · 0.0.1 · 4.4KiB
u24.aarch64	PIGSTY 0.0.1 u24.aarch64.pg18 : postgresql-18-pg-schedoc postgresql-18-pg-schedoc_0.0.1-1PIGSTY~noble_arm64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u24.aarch64.pg17 : postgresql-17-pg-schedoc postgresql-17-pg-schedoc_0.0.1-1PIGSTY~noble_arm64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u24.aarch64.pg16 : postgresql-16-pg-schedoc postgresql-16-pg-schedoc_0.0.1-1PIGSTY~noble_arm64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u24.aarch64.pg15 : postgresql-15-pg-schedoc postgresql-15-pg-schedoc_0.0.1-1PIGSTY~noble_arm64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u24.aarch64.pg14 : postgresql-14-pg-schedoc postgresql-14-pg-schedoc_0.0.1-1PIGSTY~noble_arm64.deb PIGSTY · 0.0.1 · 4.4KiB
u26.x86_64	PIGSTY 0.0.1 u26.x86_64.pg18 : postgresql-18-pg-schedoc postgresql-18-pg-schedoc_0.0.1-1PIGSTY~resolute_amd64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u26.x86_64.pg17 : postgresql-17-pg-schedoc postgresql-17-pg-schedoc_0.0.1-1PIGSTY~resolute_amd64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u26.x86_64.pg16 : postgresql-16-pg-schedoc postgresql-16-pg-schedoc_0.0.1-1PIGSTY~resolute_amd64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u26.x86_64.pg15 : postgresql-15-pg-schedoc postgresql-15-pg-schedoc_0.0.1-1PIGSTY~resolute_amd64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u26.x86_64.pg14 : postgresql-14-pg-schedoc postgresql-14-pg-schedoc_0.0.1-1PIGSTY~resolute_amd64.deb PIGSTY · 0.0.1 · 4.4KiB
u26.aarch64	PIGSTY 0.0.1 u26.aarch64.pg18 : postgresql-18-pg-schedoc postgresql-18-pg-schedoc_0.0.1-1PIGSTY~resolute_arm64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u26.aarch64.pg17 : postgresql-17-pg-schedoc postgresql-17-pg-schedoc_0.0.1-1PIGSTY~resolute_arm64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u26.aarch64.pg16 : postgresql-16-pg-schedoc postgresql-16-pg-schedoc_0.0.1-1PIGSTY~resolute_arm64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u26.aarch64.pg15 : postgresql-15-pg-schedoc postgresql-15-pg-schedoc_0.0.1-1PIGSTY~resolute_arm64.deb PIGSTY · 0.0.1 · 4.4KiB	PIGSTY 0.0.1 u26.aarch64.pg14 : postgresql-14-pg-schedoc postgresql-14-pg-schedoc_0.0.1-1PIGSTY~resolute_arm64.deb PIGSTY · 0.0.1 · 4.4KiB

Build

You can build the RPM / DEB packages for pg_schedoc using pig build:

pig build pkg pg_schedoc         # build RPM / DEB packages

Install

You can install pg_schedoc 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_schedoc;          # Install for current active PG version

pig

pig ext install -y pg_schedoc -v 18  # PG 18
pig ext install -y pg_schedoc -v 17  # PG 17
pig ext install -y pg_schedoc -v 16  # PG 16
pig ext install -y pg_schedoc -v 15  # PG 15
pig ext install -y pg_schedoc -v 14  # PG 14

dnf

dnf install -y pg_schedoc_18       # PG 18
dnf install -y pg_schedoc_17       # PG 17
dnf install -y pg_schedoc_16       # PG 16
dnf install -y pg_schedoc_15       # PG 15
dnf install -y pg_schedoc_14       # PG 14

apt

apt install -y postgresql-18-pg-schedoc   # PG 18
apt install -y postgresql-17-pg-schedoc   # PG 17
apt install -y postgresql-16-pg-schedoc   # PG 16
apt install -y postgresql-15-pg-schedoc   # PG 15
apt install -y postgresql-14-pg-schedoc   # PG 14

Create Extension:

CREATE EXTENSION schedoc CASCADE;  -- requires: ddl_historization

Usage

schedoc: Schema documentation via COMMENT on PostgreSQL objects

Builds automatic documentation from COMMENT on PostgreSQL objects. Requires the ddl_historization extension.

Setup

CREATE EXTENSION schedoc CASCADE;
SELECT schedoc_start();

Adding Column Documentation

Set comments on columns in JSON format with predefined fields:

COMMENT ON COLUMN my_table.id IS '{"status": "private"}';
COMMENT ON COLUMN my_table.email IS '{"status": "public"}';
COMMENT ON COLUMN my_table.name IS '{"status": "internal"}';

Querying Documentation

Query the parsed column comments:

SELECT * FROM schedoc_column_comments;

Result:

 databasename | tablename | columnname | status
--------------+-----------+------------+---------
 mydb         | my_table  | id         | private
 mydb         | my_table  | email      | public
 mydb         | my_table  | name       | internal

Use Case

Cross-reference column metadata with other systems (e.g., Django db_comment, DBT docs) to define data contracts between developers and data analysts.

schedoc

Overview

Version

Build

Install

Usage

Setup

Adding Column Documentation

Querying Documentation

Use Case

Was this page helpful?