schedoc
在Django与DBT之间通过注释文档交换元数据
仓库
ZeroGachis/pg_schedoc
https://github.com/ZeroGachis/pg_schedoc
源码
pg_schedoc-0.0.1.tar.gz
pg_schedoc-0.0.1.tar.gz
概览
| 扩展包名 | 版本 | 分类 | 许可证 | 语言 |
|---|---|---|---|---|
pg_schedoc | 0.0.1 | UTIL | GPL-3.0 | SQL |
| ID | 扩展名 | Bin | Lib | Load | Create | Trust | Reloc | 模式 |
|---|---|---|---|---|---|---|---|---|
| 4330 | schedoc | 否 | 否 | 否 | 是 | 否 | 否 | - |
| 相关扩展 | ddl_historization pg_readme_test_extension pg_readme gzip bzip zstd http pg_net pg_curl |
|---|
版本
| 类型 | 仓库 | 版本 | PG 大版本 | 包名 | 依赖 |
|---|---|---|---|---|---|
| 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 |
构建
您可以使用 pig build 命令构建 pg_schedoc 扩展的 RPM / DEB 包：
pig build pkg pg_schedoc # 构建 RPM / DEB 包
安装
您可以直接安装 pg_schedoc 扩展包的预置二进制包，首先确保 PGDG 和 PIGSTY 仓库已经添加并启用：
pig repo add pgsql -u # 添加仓库并更新缓存
使用 pig 或者是 apt/yum/dnf 安装扩展：
pig install pg_schedoc; # 当前活跃 PG 版本安装
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 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 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 schedoc CASCADE; -- 依赖: ddl_historization
用法
从 PostgreSQL 对象的 COMMENT 构建自动文档。需要 ddl_historization 扩展。
安装
CREATE EXTENSION schedoc CASCADE;
SELECT schedoc_start();
添加列文档
以 JSON 格式在列上设置注释，包含预定义字段：
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"}';
查询文档
查询已解析的列注释：
SELECT * FROM schedoc_column_comments;
结果：
databasename | tablename | columnname | status
--------------+-----------+------------+---------
mydb | my_table | id | private
mydb | my_table | email | public
mydb | my_table | name | internal
使用场景
将列元数据与其他系统（如 Django db_comment、DBT docs）进行交叉引用，在开发人员和数据分析师之间定义数据契约。