migrator Docker镜像文档

镜像概述和主要用途

migrator是一款用Go编写的超快速轻量级数据库迁移工具，该Docker镜像提供了便捷的部署方式。它能够高效管理和版本化所有数据库变更，消除手动且容易出错的管理任务，其版本可用于审计和合规目的。migrator支持多schema，是多租户SaaS产品的理想数据库迁移解决方案。通过HTTP GraphQL服务运行，可轻松集成到现有持续集成和持续交付（CI/CD）管道，还能从遗留框架同步现有迁移，简化技术切换过程。

核心功能和特性

性能优势

• 超快速轻量级：执行时间和内存消耗优于市场上其他领先的数据库迁移框架几个数量级。

多租户数据库支持

• PostgreSQL 9.6+（及所有衍生版本）
• MySQL 5.6+（及所有衍生版本）
• Microsoft SQL Server 2008 R2+

迁移文件来源

支持从多种位置读取数据库迁移文件：

• 本地文件夹（适用于Docker/Kubernetes部署）
• AWS S3
• Azure Blob Containers

服务与集成

• HTTP GraphQL服务：便于集成到现有系统
• CI/CD集成：可轻松融入持续集成和持续交付流程
• 遗留框架迁移同步：支持从遗留迁移框架同步现有迁移

其他特性

• 多schema支持：开箱即用地支持多schema，适合多租户SaaS产品
• 版本审计与合规：迁移版本可用于审计和合规目的
• 轻量级镜像：镜像大小仅30MB，非常适合微服务部署

使用场景和适用范围

• 多租户SaaS产品：需管理多个租户数据库schema的场景
• 微服务部署：需要高效、轻量级迁移工具的微服务架构
• CI/CD自动化：在CI/CD管道中实现数据库变更的自动化管理
• 遗留系统迁移：从遗留数据库迁移框架平滑过渡
• 审计与合规需求：需要数据库变更版本化记录的场景

使用方法和配置说明

Docker运行示例

基本本地文件迁移（PostgreSQL）

docker run -d \
  -p 8080:8080 \
  -e DB_TYPE="postgresql" \
  -e DB_CONNECTION="postgresql://user:password@postgres-host:5432/dbname?sslmode=disable" \
  -e MIGRATIONS_SOURCE="local" \
  -v /path/to/local/migrations:/app/migrations \
  --name migrator-service \
  lukaszbudnik/migrator

AWS S3迁移文件（MySQL）

docker run -d \
  -p 8080:8080 \
  -e DB_TYPE="mysql" \
  -e DB_CONNECTION="mysql://user:password@mysql-host:3306/dbname" \
  -e MIGRATIONS_SOURCE="s3" \
  -e AWS_REGION="us-east-1" \
  -e AWS_ACCESS_KEY_ID="your-access-key" \
  -e AWS_SECRET_ACCESS_KEY="your-secret-key" \
  -e S3_BUCKET="your-migrations-bucket" \
  -e S3_PREFIX="migrations/mysql" \
  --name migrator-service \
  lukaszbudnik/migrator

主要环境变量配置

访问GraphQL服务

启动容器后，可通过http://localhost:8080/graphql访问GraphQL界面，执行迁移操作、查询迁移历史等。具体GraphQL查询和变更示例可参考官方文档。

完整文档

更多详细配置和使用说明，请参阅官方GitHub文档。