dbmigrate

DBMigrate 包

基于 golang-migrate 的数据库迁移封装，支持 MySQL、PostgreSQL、SQLite。

定位

dbmigrate 是工具型包：

• 纯函数式 API，无全局状态
• 接受已有的 *sql.DB 连接，不负责建连
• 每次调用独立创建和销毁 migrate 实例，无需生命周期管理

安装

go get github.com/tsopia/go-kit/dbmigrate

快速开始

package main

import (
	"context"
	"database/sql"
	"log"

	"github.com/tsopia/go-kit/dbmigrate"
	_ "github.com/go-sql-driver/mysql"
)

func main() {
	db, err := sql.Open("mysql", "user:pass@tcp(127.0.0.1:3306)/app")
	if err != nil {
		log.Fatal(err)
	}
	defer db.Close()

	cfg := dbmigrate.Config{
		SourcePath: "./migrations",
		DB:         db,
		DriverName: "mysql",
	}

	// 执行所有待处理的迁移
	if err := dbmigrate.Up(context.Background(), cfg); err != nil {
		log.Fatal(err)
	}
}

配置说明

API

迁移文件命名

迁移文件放在 SourcePath 指定的目录下，命名格式：

000001_create_users.up.sql
000001_create_users.down.sql
000002_add_email_index.up.sql
000002_add_email_index.down.sql

常用操作

查看当前版本

status, err := dbmigrate.Status(ctx, cfg)
if err != nil {
	return fmt.Errorf("check migration status: %w", err)
}
fmt.Printf("Version: %d, Dirty: %v\n", status.Version, status.Dirty)

回退一个版本

if err := dbmigrate.Down(ctx, cfg); err != nil {
	return fmt.Errorf("rollback migration: %w", err)
}

修复脏状态

迁移中断后数据库可能处于脏状态，使用 Force 修复：

if err := dbmigrate.Force(ctx, cfg, int(targetVersion)); err != nil {
	return fmt.Errorf("force version: %w", err)
}

与 database 包集成

db, err := database.New(&database.Config{Driver: "mysql", /* ... */})
if err != nil {
	return err
}
defer db.Close()

sqlDB, err := db.SQLDB()
if err != nil {
	return err
}

cfg := dbmigrate.Config{
	SourcePath: "./migrations",
	DB:         sqlDB,
	DriverName: "mysql",
}
dbmigrate.Up(ctx, cfg)

测试

go test ./dbmigrate -v