technowledgy/pg_dev

pg_dev

概述和主要用途

pg_dev镜像基于官方PostgreSQL Docker镜像构建，集成了多种开发工具，旨在为PostgreSQL数据库开发提供便捷的集成环境。它可作为开发阶段的即插即用替代品，而生产环境建议使用官方PostgreSQL镜像。

核心功能和特性

捆绑工具

当前包含以下开发工具：

• pgTAP：PostgreSQL的测试框架，用于编写单元测试。
• pg_prove：用于运行pgTAP测试的工具，将测试结果输出为TAP格式。

辅助脚本

还包含多个简化开发流程的辅助脚本：

• tool：启动tmux会话，集中管理其他脚本的输出。
• with async：运行交互式命令（如shell或psql），不阻塞命令执行链。
• with menu：提供菜单界面，用于选择其他with系列辅助脚本。
• with pg：创建临时数据库用于测试，灵感源自https://github.com/PostgREST/postgrest/blob/main/test/with_tmp_db%E7%9A%84%E4%B8%B4%E6%97%B6%E6%95%B0%E6%8D%AE%E5%BA%93%E6%96%B9%E6%A1%88%E3%80%82
• with sql：通过psql从.sql文件创建数据库模式的包装器。
• with watcher：启用测试监视模式，文件变化时自动重新运行测试。

使用场景和适用范围

适用于PostgreSQL数据库开发场景，特别是：

• 编写和执行pgTAP测试（.spec.sql文件）
• 需要临时隔离的数据库环境进行测试验证
• 自动化监视文件变化并触发测试
• 通过菜单快速选择开发工具和工作流

使用方法

基本用法示例

挂载源代码到容器并运行带监视模式的临时数据库测试：

bash
docker run --rm -v "$PWD:/usr/src" \
  tool \
    with menu \
    with watcher \
    with pg \
    with_sql schema.sql \
    with pg_prove -r --ext .spec.sql --pgtap-option suffix=.sql

命令解析

• --rm -v "$PWD:/usr/src"：挂载当前目录到容器的/usr/src，使源代码可访问并自动清理容器
• tool：启动tmux会话管理输出
• with menu：显示脚本选择菜单
• with watcher：启用文件监视模式
• with pg：创建临时测试数据库
• with_sql schema.sql：通过psql加载schema.sql中的数据库模式
• with pg_prove ...：递归运行所有.spec.sql文件的测试，设置pgTAP选项

执行流程

1. 通过psql加载schema.sql定义的数据库模式
2. 在临时数据库中创建pgtap模式并启用pgTAP扩展
3. 递归查找并执行所有.spec.sql文件的测试
4. 监视文件变化，自动重新执行测试流程