awayteam/migrate

migrate

一个用Go编写的迁移助手，可集成到现有Go代码中或通过CLI执行数据库迁移命令。

核心功能

• 易于实现Driver接口，支持扩展多种数据库
• 在^C时优雅退出正在运行的迁移
• 无魔法搜索路径或硬编码配置文件
• CLI基于migrate包构建，功能与代码集成一致

可用驱动

• PostgreSQL
• Cassandra
• MySQL（实验性）
• SQLite（计划中）
• Bash（计划中）

使用场景

• 创建新的迁移文件
• 应用所有可用迁移
• 回滚所有或指定数量的迁移
• 重置迁移（先回滚再应用）
• 查看当前迁移版本
• 跳转到特定迁移版本

配置说明

使用时需指定数据库URL（格式：driver://url）和迁移文件路径。

Docker部署示例

Dockerfile

dockerfile
FROM awayteam/migrate
ADD ./build/migration /migration

构建镜像

bash
docker build -t <registry>/<service>-migrate:<tag> .

运行迁移

bash
docker run <registry>/<service>-migrate:<tag> -url driver://url -path ./migrations up

CLI使用示例

bash
# 安装CLI工具
go get github.com/mattes/migrate

# 创建迁移文件
migrate -url driver://url -path ./migrations create migration_file_xyz

# 回滚最近一次迁移
migrate -url driver://url -path ./migrations migrate -1

Go代码集成示例

go
import "github.com/mattes/migrate/migrate"

// 同步执行迁移
allErrors, ok := migrate.UpSync("driver://url", "./path")
if !ok {
  fmt.Println("迁移失败")
  // 处理错误
}

// 异步执行迁移
pipe := migrate.NewPipe()
go migrate.Up(pipe, "driver://url", "./path")
// 监听pipe通道获取结果

迁移文件格式

迁移文件需成对存在，命名格式如下：

001_initial.up.sql   # 升级迁移指令
001_initial.down.sql # 回滚迁移指令

文件扩展名由使用的数据库驱动决定。