Godfish - 多数据库迁移管理工具

Godfish 是一个用 Go 语言编写的数据库迁移管理工具，支持多种数据库系统，包括 Cassandra、MySQL、PostgreSQL 和 SQLite3。它提供了原生查询支持，使得开发者可以针对不同数据库编写特定的迁移脚本。

主要特性

1. 支持多种数据库系统
2. 原生查询支持
3. 版本控制
4. 迁移回滚功能
5. 命令行工具集成

安装

go get github.com/rafaelespinoza/godfish

基本用法

初始化迁移项目

package main

import (
	"github.com/rafaelespinoza/godfish"
	"github.com/rafaelespinoza/godfish/drivers/mysql"
)

func main() {
	// 选择数据库驱动
	driver := mysql.NewDriver()
	
	// 初始化迁移目录
	err := godfish.Init(driver, "migrations")
	if err != nil {
		panic(err)
	}
}

创建新迁移

package main

import (
	"github.com/rafaelespinoza/godfish"
	"github.com/rafaelespinoza/godfish/drivers/postgres"
)

func main() {
	driver := postgres.NewDriver()
	
	// 创建新的迁移文件
	err := godfish.Create(driver, "migrations", "create_users_table")
	if err != nil {
		panic(err)
	}
}

编写迁移脚本

Godfish 会为每个迁移创建两个文件：<timestamp>_<name>_up.sql 和 <timestamp>_<name>_down.sql。

示例 MySQL 迁移文件 (up):

CREATE TABLE users (
    id INT AUTO_INCREMENT PRIMARY KEY,
    username VARCHAR(255) NOT NULL,
    email VARCHAR(255) NOT NULL UNIQUE,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

对应的回滚文件 (down):

DROP TABLE users;

执行迁移

package main

import (
	"database/sql"
	"fmt"
	
	"github.com/rafaelespinoza/godfish"
	"github.com/rafaelespinoza/godfish/drivers/mysql"
	_ "github.com/go-sql-driver/mysql"
)

func main() {
	// 建立数据库连接
	db, err := sql.Open("mysql", "user:password@tcp(127.0.0.1:3306)/dbname")
	if err != nil {
		panic(err)
	}
	defer db.Close()
	
	// 初始化驱动
	driver := mysql.NewDriverWithDB(db)
	
	// 执行所有待处理的迁移
	err = godfish.Migrate(driver, "migrations", godfish.Forward)
	if err != nil {
		panic(err)
	}
	
	fmt.Println("Migrations applied successfully!")
}

回滚迁移

// 回滚最近一次迁移
err = godfish.Migrate(driver, "migrations", godfish.Backward)
if err != nil {
    panic(err)
}

多数据库支持示例

PostgreSQL 示例

package main

import (
	"database/sql"
	
	"github.com/rafaelespinoza/godfish"
	"github.com/rafaelespinoza/godfish/drivers/postgres"
	_ "github.com/lib/pq"
)

func main() {
	db, err := sql.Open("postgres", "postgres://user:password@localhost/dbname?sslmode=disable")
	if err != nil {
		panic(err)
	}
	defer db.Close()
	
	driver := postgres.NewDriverWithDB(db)
	
	// 执行迁移
	err = godfish.Migrate(driver, "migrations", godfish.Forward)
	if err != nil {
		panic(err)
	}
}

SQLite 示例

package main

import (
	"database/sql"
	
	"github.com/rafaelespinoza/godfish"
	"github.com/rafaelespinoza/godfish/drivers/sqlite"
	_ "github.com/mattn/go-sqlite3"
)

func main() {
	db, err := sql.Open("sqlite3", "./test.db")
	if err != nil {
		panic(err)
	}
	defer db.Close()
	
	driver := sqlite.NewDriverWithDB(db)
	
	// 执行迁移
	err = godfish.Migrate(driver, "migrations", godfish.Forward)
	if err != nil {
		panic(err)
	}
}

Cassandra 示例

package main

import (
	"github.com/gocql/gocql"
	"github.com/rafaelespinoza/godfish"
	"github.com/rafaelespinoza/godfish/drivers/cassandra"
)

func main() {
	cluster := gocql.NewCluster("127.0.0.1")
	cluster.Keyspace = "mykeyspace"
	session, err := cluster.CreateSession()
	if err != nil {
		panic(err)
	}
	defer session.Close()
	
	driver := cassandra.NewDriverWithSession(session)
	
	// 执行迁移
	err = godfish.Migrate(driver, "migrations", godfish.Forward)
	if err != nil {
		panic(err)
	}
}

高级功能

条件迁移

Godfish 允许你在迁移脚本中使用数据库特定的语法：

-- PostgreSQL 示例
CREATE TABLE IF NOT EXISTS users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100) NOT NULL
);

-- MySQL 示例
CREATE TABLE IF NOT EXISTS users (
    id INT AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(100) NOT NULL
);

事务支持

Godfish 支持事务性迁移，确保迁移要么完全成功，要么完全失败：

// 在迁移时启用事务
err = godfish.Migrate(driver, "migrations", godfish.Forward, godfish.WithTransaction(true))
if err != nil {
    panic(err)
}

总结

Godfish 是一个功能强大的多数据库迁移工具，它支持多种流行的数据库系统，并提供原生查询支持。通过简单的 API 和清晰的迁移文件结构，Godfish 使得数据库版本控制和迁移管理变得简单可靠。

无论是小型项目还是大型企业应用，Godfish 都能提供灵活的数据库迁移解决方案，帮助开发者更好地管理数据库结构变更。