Darwin - Golang数据库模式演进管理工具

Darwin是一个用于Golang的数据库模式演进管理工具，它可以帮助开发者管理数据库模式的变更历史，类似于Ruby的Rails Migrations或Java的Flyway。

主要特性

1. 支持多种数据库：MySQL, PostgreSQL, SQLite等
2. 使用Go代码编写迁移脚本
3. 维护迁移历史表
4. 支持迁移回滚
5. 简单的API接口

安装

go get github.com/GuiaBolso/darwin

基本使用示例

1. 初始化Darwin和数据库连接

package main

import (
	"database/sql"
	"fmt"
	"log"

	"github.com/GuiaBolso/darwin"
	_ "github.com/go-sql-driver/mysql"
)

func main() {
	// 初始化数据库连接
	db, err := sql.Open("mysql", "user:password@tcp(127.0.0.1:3306)/dbname?parseTime=true")
	if err != nil {
		log.Fatal(err)
	}
	defer db.Close()

	// 创建Darwin实例
	driver := darwin.NewGenericDriver(db, darwin.MySQLDialect{})

	d := darwin.New(driver, migrations, nil)

	// 执行迁移
	if err := d.Migrate(); err != nil {
		fmt.Println("Migration failed:", err)
	}
}

// 定义迁移集合
var migrations = []darwin.Migration{
	{
		Version:     1,
		Description: "Creating table users",
		Script: `
			CREATE TABLE users (
				id INT AUTO_INCREMENT PRIMARY KEY,
				name VARCHAR(255) NOT NULL,
				email VARCHAR(255) NOT NULL UNIQUE,
				created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
			);
		`,
	},
	{
		Version:     2,
		Description: "Adding age column to users",
		Script: `
			ALTER TABLE users 
			ADD COLUMN age INT DEFAULT 0;
		`,
	},
}

2. 使用Go函数作为迁移脚本

除了SQL语句，Darwin也支持使用Go函数作为迁移脚本：

var migrations = []darwin.Migration{
	{
		Version:     1,
		Description: "Creating table products",
		Up: func(driver darwin.Driver) error {
			_, err := driver.Exec(`
				CREATE TABLE products (
					id INT AUTO_INCREMENT PRIMARY KEY,
					name VARCHAR(255) NOT NULL,
					price DECIMAL(10,2) NOT NULL
				);
			`)
			return err
		},
		Down: func(driver darwin.Driver) error {
			_, err := driver.Exec(`DROP TABLE products;`)
			return err
		},
	},
}

3. 检查迁移状态

// 获取已应用的迁移
applied, err := d.AppliedMigrations()
if err != nil {
	log.Fatal(err)
}

fmt.Println("Applied migrations:")
for _, m := range applied {
	fmt.Printf("Version: %d, Description: %s, Applied at: %v\n", 
		m.Version, m.Description, m.AppliedAt)
}

4. 自定义迁移表名

默认情况下，Darwin使用darwin_migrations表来跟踪迁移历史。你可以自定义这个表名：

driver := darwin.NewGenericDriver(db, darwin.MySQLDialect{})
driver.SetTableName("custom_migrations_table")

d := darwin.New(driver, migrations, nil)

高级用法

1. 使用事务

var migrations = []darwin.Migration{
	{
		Version:     3,
		Description: "Transaction example",
		Up: func(driver darwin.Driver) error {
			tx, err := driver.Begin()
			if err != nil {
				return err
			}
			
			// 执行多个SQL语句
			if _, err := tx.Exec(`INSERT INTO users (name, email) VALUES (?, ?)`, "Alice", "alice@example.com"); err != nil {
				tx.Rollback()
				return err
			}
			
			if _, err := tx.Exec(`UPDATE products SET price = price * 1.1`); err != nil {
				tx.Rollback()
				return err
			}
			
			return tx.Commit()
		},
	},
}

2. 使用Logger

Darwin允许你传入自定义logger来记录迁移过程：

type myLogger struct{}

func (l myLogger) Printf(format string, args ...interface{}) {
	log.Printf("[DARWIN] "+format, args...)
}

func main() {
	// ... 初始化db和driver ...
	
	d := darwin.New(driver, migrations, myLogger{})
	
	// ... 执行迁移 ...
}

注意事项

1. 迁移是按版本号顺序执行的，确保版本号递增
2. 一旦迁移被应用，就不应该修改它
3. 在生产环境使用前，先在开发环境测试所有迁移
4. 考虑在迁移脚本中添加错误处理和回滚逻辑

Darwin是一个简单但功能强大的数据库迁移工具，特别适合Go项目中使用。它避免了XML或JSON配置文件的复杂性，直接使用Go代码来定义迁移，使得迁移脚本更加灵活和强大。