跳转到主要内容

schedoc

Cross documentation between Django and DBT projects

pg_schedoc : Cross documentation between Django and DBT projects

Overview

ID Extension Package Version Category License Language
4330 schedoc pg_schedoc 0.0.1 UTIL GPL-3.0 SQL
Attribute Has Binary Has Library Need Load Has DDL Relocatable Trusted
----d-- No No No Yes no no

Packages

Type Repo Version PG Major Compatibility Package Pattern Dependencies
EXT PIGSTY 0.0.1 18 17 16 15 14 pg_schedoc ddl_historization
RPM PIGSTY 0.0.1 18 17 16 15 14 pg_schedoc_$v ddl_historization_$v
DEB PIGSTY 0.0.1 18 17 16 15 14 postgresql-$v-pg-schedoc postgresql-$v-ddl-historization
Linux / PG PG18 PG17 PG16 PG15 PG14
el8.x86_64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
el8.aarch64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
el9.x86_64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
el9.aarch64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
el10.x86_64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
el10.aarch64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
d12.x86_64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
d12.aarch64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
d13.x86_64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
d13.aarch64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
u22.x86_64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
u22.aarch64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
u24.x86_64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
u24.aarch64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
u26.x86_64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
u26.aarch64 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1 PIGSTY 0.0.1
Package Version OS ORG SIZE File URL
pg_schedoc_18 0.0.1 el8.x86_64 pigsty 22.9 KiB pg_schedoc_18-0.0.1-1PIGSTY.el8.x86_64.rpm
pg_schedoc_18 0.0.1 el8.aarch64 pigsty 22.9 KiB pg_schedoc_18-0.0.1-1PIGSTY.el8.aarch64.rpm
pg_schedoc_18 0.0.1 el9.x86_64 pigsty 22.5 KiB pg_schedoc_18-0.0.1-1PIGSTY.el9.x86_64.rpm
pg_schedoc_18 0.0.1 el9.aarch64 pigsty 22.5 KiB pg_schedoc_18-0.0.1-1PIGSTY.el9.aarch64.rpm
pg_schedoc_18 0.0.1 el10.x86_64 pigsty 22.6 KiB pg_schedoc_18-0.0.1-1PIGSTY.el10.x86_64.rpm
pg_schedoc_18 0.0.1 el10.aarch64 pigsty 22.6 KiB pg_schedoc_18-0.0.1-1PIGSTY.el10.aarch64.rpm
postgresql-18-pg-schedoc 0.0.1 d12.x86_64 pigsty 4.5 KiB postgresql-18-pg-schedoc_0.0.1-1PIGSTY~bookworm_amd64.deb
postgresql-18-pg-schedoc 0.0.1 d12.aarch64 pigsty 4.5 KiB postgresql-18-pg-schedoc_0.0.1-1PIGSTY~bookworm_arm64.deb
postgresql-18-pg-schedoc 0.0.1 d13.x86_64 pigsty 4.5 KiB postgresql-18-pg-schedoc_0.0.1-1PIGSTY~trixie_amd64.deb
postgresql-18-pg-schedoc 0.0.1 d13.aarch64 pigsty 4.5 KiB postgresql-18-pg-schedoc_0.0.1-1PIGSTY~trixie_arm64.deb
postgresql-18-pg-schedoc 0.0.1 u22.x86_64 pigsty 4.4 KiB postgresql-18-pg-schedoc_0.0.1-1PIGSTY~jammy_amd64.deb
postgresql-18-pg-schedoc 0.0.1 u22.aarch64 pigsty 4.4 KiB postgresql-18-pg-schedoc_0.0.1-1PIGSTY~jammy_arm64.deb
postgresql-18-pg-schedoc 0.0.1 u24.x86_64 pigsty 4.4 KiB postgresql-18-pg-schedoc_0.0.1-1PIGSTY~noble_amd64.deb
postgresql-18-pg-schedoc 0.0.1 u24.aarch64 pigsty 4.4 KiB postgresql-18-pg-schedoc_0.0.1-1PIGSTY~noble_arm64.deb
postgresql-18-pg-schedoc 0.0.1 u26.x86_64 pigsty 4.4 KiB postgresql-18-pg-schedoc_0.0.1-1PIGSTY~resolute_amd64.deb
postgresql-18-pg-schedoc 0.0.1 u26.aarch64 pigsty 4.4 KiB postgresql-18-pg-schedoc_0.0.1-1PIGSTY~resolute_arm64.deb
Package Version OS ORG SIZE File URL
pg_schedoc_17 0.0.1 el8.x86_64 pigsty 22.9 KiB pg_schedoc_17-0.0.1-1PIGSTY.el8.x86_64.rpm
pg_schedoc_17 0.0.1 el8.aarch64 pigsty 22.9 KiB pg_schedoc_17-0.0.1-1PIGSTY.el8.aarch64.rpm
pg_schedoc_17 0.0.1 el9.x86_64 pigsty 22.5 KiB pg_schedoc_17-0.0.1-1PIGSTY.el9.x86_64.rpm
pg_schedoc_17 0.0.1 el9.aarch64 pigsty 22.5 KiB pg_schedoc_17-0.0.1-1PIGSTY.el9.aarch64.rpm
pg_schedoc_17 0.0.1 el10.x86_64 pigsty 22.6 KiB pg_schedoc_17-0.0.1-1PIGSTY.el10.x86_64.rpm
pg_schedoc_17 0.0.1 el10.aarch64 pigsty 22.6 KiB pg_schedoc_17-0.0.1-1PIGSTY.el10.aarch64.rpm
postgresql-17-pg-schedoc 0.0.1 d12.x86_64 pigsty 4.5 KiB postgresql-17-pg-schedoc_0.0.1-1PIGSTY~bookworm_amd64.deb
postgresql-17-pg-schedoc 0.0.1 d12.aarch64 pigsty 4.5 KiB postgresql-17-pg-schedoc_0.0.1-1PIGSTY~bookworm_arm64.deb
postgresql-17-pg-schedoc 0.0.1 d13.x86_64 pigsty 4.5 KiB postgresql-17-pg-schedoc_0.0.1-1PIGSTY~trixie_amd64.deb
postgresql-17-pg-schedoc 0.0.1 d13.aarch64 pigsty 4.5 KiB postgresql-17-pg-schedoc_0.0.1-1PIGSTY~trixie_arm64.deb
postgresql-17-pg-schedoc 0.0.1 u22.x86_64 pigsty 4.4 KiB postgresql-17-pg-schedoc_0.0.1-1PIGSTY~jammy_amd64.deb
postgresql-17-pg-schedoc 0.0.1 u22.aarch64 pigsty 4.4 KiB postgresql-17-pg-schedoc_0.0.1-1PIGSTY~jammy_arm64.deb
postgresql-17-pg-schedoc 0.0.1 u24.x86_64 pigsty 4.4 KiB postgresql-17-pg-schedoc_0.0.1-1PIGSTY~noble_amd64.deb
postgresql-17-pg-schedoc 0.0.1 u24.aarch64 pigsty 4.4 KiB postgresql-17-pg-schedoc_0.0.1-1PIGSTY~noble_arm64.deb
postgresql-17-pg-schedoc 0.0.1 u26.x86_64 pigsty 4.4 KiB postgresql-17-pg-schedoc_0.0.1-1PIGSTY~resolute_amd64.deb
postgresql-17-pg-schedoc 0.0.1 u26.aarch64 pigsty 4.4 KiB postgresql-17-pg-schedoc_0.0.1-1PIGSTY~resolute_arm64.deb
Package Version OS ORG SIZE File URL
pg_schedoc_16 0.0.1 el8.x86_64 pigsty 22.9 KiB pg_schedoc_16-0.0.1-1PIGSTY.el8.x86_64.rpm
pg_schedoc_16 0.0.1 el8.aarch64 pigsty 22.9 KiB pg_schedoc_16-0.0.1-1PIGSTY.el8.aarch64.rpm
pg_schedoc_16 0.0.1 el9.x86_64 pigsty 22.5 KiB pg_schedoc_16-0.0.1-1PIGSTY.el9.x86_64.rpm
pg_schedoc_16 0.0.1 el9.aarch64 pigsty 22.5 KiB pg_schedoc_16-0.0.1-1PIGSTY.el9.aarch64.rpm
pg_schedoc_16 0.0.1 el10.x86_64 pigsty 22.6 KiB pg_schedoc_16-0.0.1-1PIGSTY.el10.x86_64.rpm
pg_schedoc_16 0.0.1 el10.aarch64 pigsty 22.6 KiB pg_schedoc_16-0.0.1-1PIGSTY.el10.aarch64.rpm
postgresql-16-pg-schedoc 0.0.1 d12.x86_64 pigsty 4.5 KiB postgresql-16-pg-schedoc_0.0.1-1PIGSTY~bookworm_amd64.deb
postgresql-16-pg-schedoc 0.0.1 d12.aarch64 pigsty 4.5 KiB postgresql-16-pg-schedoc_0.0.1-1PIGSTY~bookworm_arm64.deb
postgresql-16-pg-schedoc 0.0.1 d13.x86_64 pigsty 4.5 KiB postgresql-16-pg-schedoc_0.0.1-1PIGSTY~trixie_amd64.deb
postgresql-16-pg-schedoc 0.0.1 d13.aarch64 pigsty 4.5 KiB postgresql-16-pg-schedoc_0.0.1-1PIGSTY~trixie_arm64.deb
postgresql-16-pg-schedoc 0.0.1 u22.x86_64 pigsty 4.4 KiB postgresql-16-pg-schedoc_0.0.1-1PIGSTY~jammy_amd64.deb
postgresql-16-pg-schedoc 0.0.1 u22.aarch64 pigsty 4.4 KiB postgresql-16-pg-schedoc_0.0.1-1PIGSTY~jammy_arm64.deb
postgresql-16-pg-schedoc 0.0.1 u24.x86_64 pigsty 4.4 KiB postgresql-16-pg-schedoc_0.0.1-1PIGSTY~noble_amd64.deb
postgresql-16-pg-schedoc 0.0.1 u24.aarch64 pigsty 4.4 KiB postgresql-16-pg-schedoc_0.0.1-1PIGSTY~noble_arm64.deb
postgresql-16-pg-schedoc 0.0.1 u26.x86_64 pigsty 4.4 KiB postgresql-16-pg-schedoc_0.0.1-1PIGSTY~resolute_amd64.deb
postgresql-16-pg-schedoc 0.0.1 u26.aarch64 pigsty 4.4 KiB postgresql-16-pg-schedoc_0.0.1-1PIGSTY~resolute_arm64.deb
Package Version OS ORG SIZE File URL
pg_schedoc_15 0.0.1 el8.x86_64 pigsty 22.9 KiB pg_schedoc_15-0.0.1-1PIGSTY.el8.x86_64.rpm
pg_schedoc_15 0.0.1 el8.aarch64 pigsty 22.9 KiB pg_schedoc_15-0.0.1-1PIGSTY.el8.aarch64.rpm
pg_schedoc_15 0.0.1 el9.x86_64 pigsty 22.5 KiB pg_schedoc_15-0.0.1-1PIGSTY.el9.x86_64.rpm
pg_schedoc_15 0.0.1 el9.aarch64 pigsty 22.5 KiB pg_schedoc_15-0.0.1-1PIGSTY.el9.aarch64.rpm
pg_schedoc_15 0.0.1 el10.x86_64 pigsty 22.6 KiB pg_schedoc_15-0.0.1-1PIGSTY.el10.x86_64.rpm
pg_schedoc_15 0.0.1 el10.aarch64 pigsty 22.6 KiB pg_schedoc_15-0.0.1-1PIGSTY.el10.aarch64.rpm
postgresql-15-pg-schedoc 0.0.1 d12.x86_64 pigsty 4.5 KiB postgresql-15-pg-schedoc_0.0.1-1PIGSTY~bookworm_amd64.deb
postgresql-15-pg-schedoc 0.0.1 d12.aarch64 pigsty 4.5 KiB postgresql-15-pg-schedoc_0.0.1-1PIGSTY~bookworm_arm64.deb
postgresql-15-pg-schedoc 0.0.1 d13.x86_64 pigsty 4.5 KiB postgresql-15-pg-schedoc_0.0.1-1PIGSTY~trixie_amd64.deb
postgresql-15-pg-schedoc 0.0.1 d13.aarch64 pigsty 4.5 KiB postgresql-15-pg-schedoc_0.0.1-1PIGSTY~trixie_arm64.deb
postgresql-15-pg-schedoc 0.0.1 u22.x86_64 pigsty 4.4 KiB postgresql-15-pg-schedoc_0.0.1-1PIGSTY~jammy_amd64.deb
postgresql-15-pg-schedoc 0.0.1 u22.aarch64 pigsty 4.4 KiB postgresql-15-pg-schedoc_0.0.1-1PIGSTY~jammy_arm64.deb
postgresql-15-pg-schedoc 0.0.1 u24.x86_64 pigsty 4.4 KiB postgresql-15-pg-schedoc_0.0.1-1PIGSTY~noble_amd64.deb
postgresql-15-pg-schedoc 0.0.1 u24.aarch64 pigsty 4.4 KiB postgresql-15-pg-schedoc_0.0.1-1PIGSTY~noble_arm64.deb
postgresql-15-pg-schedoc 0.0.1 u26.x86_64 pigsty 4.4 KiB postgresql-15-pg-schedoc_0.0.1-1PIGSTY~resolute_amd64.deb
postgresql-15-pg-schedoc 0.0.1 u26.aarch64 pigsty 4.4 KiB postgresql-15-pg-schedoc_0.0.1-1PIGSTY~resolute_arm64.deb
Package Version OS ORG SIZE File URL
pg_schedoc_14 0.0.1 el8.x86_64 pigsty 22.9 KiB pg_schedoc_14-0.0.1-1PIGSTY.el8.x86_64.rpm
pg_schedoc_14 0.0.1 el8.aarch64 pigsty 22.9 KiB pg_schedoc_14-0.0.1-1PIGSTY.el8.aarch64.rpm
pg_schedoc_14 0.0.1 el9.x86_64 pigsty 22.5 KiB pg_schedoc_14-0.0.1-1PIGSTY.el9.x86_64.rpm
pg_schedoc_14 0.0.1 el9.aarch64 pigsty 22.5 KiB pg_schedoc_14-0.0.1-1PIGSTY.el9.aarch64.rpm
pg_schedoc_14 0.0.1 el10.x86_64 pigsty 22.6 KiB pg_schedoc_14-0.0.1-1PIGSTY.el10.x86_64.rpm
pg_schedoc_14 0.0.1 el10.aarch64 pigsty 22.6 KiB pg_schedoc_14-0.0.1-1PIGSTY.el10.aarch64.rpm
postgresql-14-pg-schedoc 0.0.1 d12.x86_64 pigsty 4.5 KiB postgresql-14-pg-schedoc_0.0.1-1PIGSTY~bookworm_amd64.deb
postgresql-14-pg-schedoc 0.0.1 d12.aarch64 pigsty 4.5 KiB postgresql-14-pg-schedoc_0.0.1-1PIGSTY~bookworm_arm64.deb
postgresql-14-pg-schedoc 0.0.1 d13.x86_64 pigsty 4.5 KiB postgresql-14-pg-schedoc_0.0.1-1PIGSTY~trixie_amd64.deb
postgresql-14-pg-schedoc 0.0.1 d13.aarch64 pigsty 4.5 KiB postgresql-14-pg-schedoc_0.0.1-1PIGSTY~trixie_arm64.deb
postgresql-14-pg-schedoc 0.0.1 u22.x86_64 pigsty 4.4 KiB postgresql-14-pg-schedoc_0.0.1-1PIGSTY~jammy_amd64.deb
postgresql-14-pg-schedoc 0.0.1 u22.aarch64 pigsty 4.4 KiB postgresql-14-pg-schedoc_0.0.1-1PIGSTY~jammy_arm64.deb
postgresql-14-pg-schedoc 0.0.1 u24.x86_64 pigsty 4.4 KiB postgresql-14-pg-schedoc_0.0.1-1PIGSTY~noble_amd64.deb
postgresql-14-pg-schedoc 0.0.1 u24.aarch64 pigsty 4.4 KiB postgresql-14-pg-schedoc_0.0.1-1PIGSTY~noble_arm64.deb
postgresql-14-pg-schedoc 0.0.1 u26.x86_64 pigsty 4.4 KiB postgresql-14-pg-schedoc_0.0.1-1PIGSTY~resolute_amd64.deb
postgresql-14-pg-schedoc 0.0.1 u26.aarch64 pigsty 4.4 KiB postgresql-14-pg-schedoc_0.0.1-1PIGSTY~resolute_arm64.deb

Source

pig build pkg pg_schedoc;		# build rpm/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_schedoc;		# install via package name, for the active PG version
pig install schedoc;		# install by extension name, for the current active PG version

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

Create this extension with:

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.