enspirit/dbagent

DbAgent：用于 PostgreSQL 数据库迁移、监控和种子数据管理的 Ruby 工具

DbAgent 通过三个主要工具帮助管理关系型数据库生命周期：

• 迁移（Migrations）：基于 Sequel 实现，可通过简单命令 rake db:migrate 执行迁移，支持超级用户和普通用户两种迁移模式。

• 监控（Spy）：使用 Schemaspy 生成可浏览的数据库 schema 文档，通过简单 Web 界面随时查看。

• 种子数据（Seed）：以分层 JSON 文件组织数据集，支持维护、安装和清空数据库内容，特别适用于自动化测试等场景。

开始使用 Docker

DbAgent 推荐以 Docker 镜像形式使用，镜像名称为 enspirit/dbagent。只需挂载迁移文件和数据文件夹即可开始使用。

详情可参考示例文件夹（examples folder）。

可用环境变量

• DBAGENT_ROOT_FOLDER 主文件夹，用于存放数据、迁移文件和视图（必填）
• DBAGENT_LOGLEVEL 日志级别，默认为 WARN
• DBAGENT_LOGSQL 是否记录 Sequel 的 SQL 查询，默认为 no
• DBAGENT_ADAPTER Sequel 适配器，默认为 postgres
• DBAGENT_HOST 数据库服务器主机，默认为 localhost
• DBAGENT_PORT 数据库服务器端口，默认为 5432
• DBAGENT_DB 数据库名称，默认为 suppliers-and-parts
• DBAGENT_USER 数据库用户，默认为 dbagent
• DBAGENT_PASSWORD 数据库密码，默认为 dbagent
• DBAGENT_SOCKET 数据库服务器 socket（当不使用 host/port 时）
• DBAGENT_SUPER_USER 超级用户名称（仅 PostgreSQL）
• DBAGENT_SUPER_DB 超级用户数据库（仅 PostgreSQL）
• DBAGENT_SUPER_PASSWORD 超级用户密码（仅 PostgreSQL）
• DBAGENT_VIEWPOINT 使用 db:flush 时的 Bmg 视图（类名）

可用 Rake 任务

以下 Rake 任务用于数据库管理，通常需在 Docker 容器内执行：

rake db:check-seeds    # 检查所有种子数据是否可正确安装
rake db:create         # 创建新用户和数据库（谨慎使用）
rake db:drop           # 删除用户和数据库（谨慎使用）
rake db:flush[to]      # 将数据库内容清空为指定数据集
rake db:migrate        # 执行数据库迁移
rake db:ping           # 测试数据库连接，确认迁移准备就绪
rake db:rebuild        # 从 scratch 重建数据库（谨慎使用）
rake db:repl           # 打开数据库 REPL 终端
rake db:seed[from]     # 安装指定种子数据集
rake db:spy            # 将 schema 文档生成到 database/schema 目录
rake db:backup         # 备份数据库到 backups 文件夹
rake db:restore[match] # 从 backups 文件夹恢复最后一个匹配的备份文件
rake db:revive         # 快捷执行 db:restore 和 db:migrate

可用 Web 服务

GET  /schema/                # 浏览数据库 schema（需先执行 `rake db:spy`）
POST /seeds/install?id=...   # 安装指定数据集，id 为 data 文件夹中的子文件夹名称
POST /seeds/flush?id=...     # 将当前数据库内容清空为指定数据集

开发 DbAgent

安装依赖库

bundle install

环境准备

测试需本地安装 PostgreSQL，并创建 suppliers-and-parts 数据库及 dbagent 用户：

sudo su postgres -c 'createuser --createdb dbagent -P'

DbAgent 默认使用 suppliers-and-parts 数据库，用户/密码为 dbagent/dbagent。如需修改，需通过环境变量调整。

安装示例数据库

DBAGENT_ROOT_FOLDER=examples/suppliers-and-parts bundle exec rake db:create db:migrate db:seed['base']

贡献指南

运行测试

测试需本地安装 Docker，执行：

make test

测试后清理资源：

make clean