infoblox/migrate

镜像概述

golang-migrate是一个基于Go语言实现的数据库迁移工具，旨在提供简单、可靠的数据库结构版本化管理方案。该工具支持多种主流数据库（如PostgreSQL、MySQL、SQLite等），通过迁移脚本（通常为SQL文件）实现数据库结构的创建、修改、删除等变更，并支持版本控制、向上迁移（执行变更）和向下迁移（回滚变更），适用于开发、测试及生产环境的数据库管理。

核心功能和特性

支持多数据库类型

• 兼容主流关系型数据库：PostgreSQL、MySQL、SQLite、SQL Server、Oracle等
• 支持部分NoSQL数据库及特殊存储：Cassandra、MongoDB、AWS DynamoDB等

迁移脚本管理

• 基于文件的迁移脚本（通常分为up（升级）和down（回滚）脚本）
• 脚本版本自动排序，确保迁移顺序一致性
• 支持SQL脚本及Go代码编写的迁移逻辑（通过自定义驱动）

灵活的运行方式

• 提供CLI（命令行）工具，支持直接执行迁移命令
• 可作为Go库集成到应用程序中，实现代码内触发迁移
• 支持通过Docker容器运行，简化环境依赖管理

版本控制与安全性

• 迁移历史记录跟踪，避免重复执行
• 支持事务包装迁移操作（部分数据库），确保迁移原子性
• 可配置超时控制，防止长时迁移阻塞

使用场景和适用范围

开发环境

• 多开发者协作时，同步数据库结构变更
• 本地开发与测试环境的数据库初始化

生产环境

• 数据库结构升级（如新增表、修改字段类型）
• 数据库版本回滚（出现问题时快速恢复）

团队协作与CI/CD

• 纳入Git版本控制，迁移脚本随代码一同管理
• 集成到CI/CD流程，实现部署时自动执行数据库迁移
• 多团队并行开发时，避免数据库变更冲突

使用方法和配置说明

基本使用（Docker运行）

1. 安装与启动

通过Docker直接运行镜像，无需本地安装依赖：

bash
# 拉取镜像（可选，运行时会自动拉取）
docker pull migrate/migrate

# 查看帮助命令
docker run --rm migrate/migrate --help

2. 核心命令示例

创建迁移脚本

创建一个新的迁移版本（包含up和down脚本）：

bash
# 格式：docker run --rm -v [本地脚本目录]:/migrations migrate/migrate create -ext sql -dir /migrations -seq [迁移名称]
docker run --rm -v $(pwd)/migrations:/migrations migrate/migrate create -ext sql -dir /migrations -seq add_users_table

执行后，在./migrations目录下生成两个文件：

• [版本号]_add_users_table.up.sql（升级脚本，如创建表）
• [版本号]_add_users_table.down.sql（回滚脚本，如删除表）

执行迁移（升级数据库）

执行所有未应用的up脚本，升级数据库结构：

bash
# 格式：docker run --rm -v [脚本目录]:/migrations migrate/migrate -database [数据库连接URL] -path /migrations up [可选：迁移步数，默认全部]
docker run --rm -v $(pwd)/migrations:/migrations migrate/migrate -database "postgres://user:password@host:port/dbname?sslmode=disable" -path /migrations up

回滚迁移（降级数据库）

执行最近的down脚本，回滚数据库结构：

bash
# 回滚最近1步迁移
docker run --rm -v $(pwd)/migrations:/migrations migrate/migrate -database "mysql://user:password@tcp(host:port)/dbname" -path /migrations down 1

# 回滚所有迁移（谨慎使用）
docker run --rm -v $(pwd)/migrations:/migrations migrate/migrate -database "sqlite3://./test.db" -path /migrations down -all

环境变量配置

通过环境变量简化数据库连接参数配置（避免命令行暴露敏感信息）：

Docker Compose示例

在多服务环境中，可通过Docker Compose集成数据库与迁移工具：

yaml
version: '3.8'
services:
  db:
    image: postgres:15
    environment:
      POSTGRES_USER: user
      POSTGRES_PASSWORD: password
      POSTGRES_DB: appdb
    ports:
      - "5432:5432"
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U user -d appdb"]
      interval: 5s
      timeout: 5s
      retries: 5

  migrate:
    image: migrate/migrate
    volumes:
      - ./migrations:/migrations  # 挂载本地迁移脚本目录
    environment:
      DB_URL: "postgres://user:password@db:5432/appdb?sslmode=disable"
    depends_on:
      db:
        condition: service_healthy  # 确保数据库就绪后执行迁移
    command: ["-path", "/migrations", "-database", "${DB_URL}", "up"]

执行docker-compose up migrate即可自动完成数据库迁移。

注意事项

• 迁移脚本需严格测试，避免生产环境执行错误导致数据丢失
• 回滚操作（down）需谨慎，建议先备份数据
• 敏感信息（如数据库密码）建议通过环境变量或密钥管理工具传入，避免硬编码
• 部分数据库（如MySQL）不支持事务内的DDL操作，迁移脚本需自行处理原子性