progressoft/dbtool

Genesis dbtool 数据库工具

概述

Genesis dbtool是Progressoft Genesis项目的官方数据库工具，专注于数据库迁移、版本控制和架构管理。该工具通过版本化迁移脚本机制，简化数据库变更流程，确保数据库架构变更可追踪、可重复，并支持与开发和部署流程无缝集成，适用于从开发到生产环境的全生命周期数据库管理。

核心功能与特性

• 版本化迁移管理：支持基于版本号的迁移脚本，自动记录迁移历史，确保变更可追溯和审计。
• 多数据库兼容：适配主流数据库系统，包括PostgreSQL、MySQL、Oracle等。
• 自动化迁移执行：提供正向迁移（应用变更）和回滚（撤销变更）功能，支持指定版本精确控制。
• 架构检查与验证：内置数据库架构一致性检查，识别潜在冲突和不兼容变更。
• CI/CD集成：支持与持续集成/持续部署流程对接，实现数据库变更的自动化部署。
• 轻量级容器化：通过Docker镜像分发，简化环境依赖管理，支持跨平台运行。

使用场景

• 开发环境初始化：开发团队基于最新迁移脚本快速构建本地或开发环境数据库。
• 生产环境变更部署：通过版本化脚本安全执行生产环境数据库架构变更。
• 多环境同步：确保开发、测试、预生产和生产环境数据库架构一致性。
• 紧急回滚处理：在变更出现问题时，快速回滚到指定稳定版本，降低业务中断风险。
• 数据库版本审计：通过迁移历史记录，追踪数据库架构演进过程。

使用方法

Docker 运行示例

基本迁移命令

bash
docker run -it --rm \
  -v /本地迁移脚本目录:/app/migrations \  # 挂载本地迁移脚本到容器内默认目录
  -e DB_HOST=your-db-host \               # 数据库主机地址
  -e DB_PORT=5432 \                       # 数据库端口（默认5432）
  -e DB_USER=db-admin \                   # 数据库用户名
  -e DB_PASSWORD=secure-password \        # 数据库密码
  -e DB_NAME=genesis-db \                 # 数据库名称
  gitlab.com/progressoft/genesis/dbtool:latest \
  migrate                                 # 执行未应用的迁移脚本

查看迁移状态

bash
docker run -it --rm \
  -v /本地迁移脚本目录:/app/migrations \
  -e DB_HOST=your-db-host \
  -e DB_USER=db-admin \
  -e DB_PASSWORD=secure-password \
  -e DB_NAME=genesis-db \
  gitlab.com/progressoft/genesis/dbtool:latest \
  status                                  # 显示已应用和未应用的迁移

回滚最近一次迁移

bash
docker run -it --rm \
  -v /本地迁移脚本目录:/app/migrations \
  -e DB_HOST=your-db-host \
  -e DB_USER=db-admin \
  -e DB_PASSWORD=secure-password \
  -e DB_NAME=genesis-db \
  gitlab.com/progressoft/genesis/dbtool:latest \
  rollback                                # 回滚最近一次迁移（默认）

常用命令

配置参数

环境变量说明