golang-migrate 使用

一、CLI方式使用

需要下载工具,之后在GOPATH目录下会多一个migrate程序

1
go install -tags 'mysql' github.com/golang-migrate/migrate/v4/cmd/migrate@latest

创建migrate项目,创建migration文件夹(用于存放迁移文件)

在migrate目录下用命令生成要迁移的up和down文件文件

-format string

要使用的时间格式字符串。如果指定了字符串”unix”或”unixNano”,则将分别使用自1970年UTC 1月1日起的秒或纳秒。注意,由于time.Time.Format()的行为,无效的格式字符串将不会出错(默认为”20060102150405”)

1
migrate create -ext sql -dir migration -format unix create_test_table

文件为空,需要自行补充sql命令

编辑up文件

例如:

1
2
3
4
5
6
CREATE TABLE IF  NOT EXISTS test(
id int(10) unsigned NOT NULL AUTO_INCREMENT,
name VARCHAR(100) NOT NULL,
password VARCHAR(40) NOT NULL,
PRIMARY KEY ( id )
);

编辑down文件

例如:

1
DROP` `table` `IF EXISTS test;

运行1个迁移文件:

1
migrate -verbose -source file://migration mysql://user:password@tcp(ip:port)/database_name up 1

version 如果-1表示版本脏了,需要加上force 20*****(生成的表前缀) 来强制版本索引,例如:

1
migrate -verbose -source file://migration -database mysql://user:password@tcp(ip:port)/database_name force 20210730160233

二、在项目中使用

1
go get -u github.com/golang-migrate/migrate
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package main

import (
"database/sql"
"log"

_ "github.com/go-sql-driver/mysql"
"github.com/golang-migrate/migrate"
"github.com/golang-migrate/migrate/database/mysql"
_ "github.com/golang-migrate/migrate/database/mysql"
_ "github.com/golang-migrate/migrate/source/file"
_ "github.com/golang-migrate/migrate/source/github"
)

func main() {
db, err := sql.Open("mysql", "user:password@tcp(ip:port)/migrate?multiStatements=true")

if err != nil {
log.Fatal(err)
}

defer db.Close()

driver, err := mysql.WithInstance(db, &mysql.Config{})

if err != nil {
log.Fatal(err)
}

m, err := migrate.NewWithDatabaseInstance(
"file://migration",
"migrate",
driver,
)
if err != nil {
log.Fatal(err)
}
err = m.Up() //or m.Down()
if err != nil {
log.Fatal(err)
}
_ = m.Steps(1) //执行的文件数
}

切记要注意import包,否则报错

last update time 2022-05-07