golang-migrate命令行的使用

, Comments

最近项目要用Go写。受Laravel的启发，想找一个Go语言的数据库版本迁移工具，然后就找到了一个大家用的比较多的工具：migrate。因为官方文档以及网上资源太少，所以这里写一篇文章记录下。

（安装这个工具的方法省略）

我们创建一个目录migrations，里面存放我们需要迁移的对象。

然后，创建迁移文件：

1
migrate create -ext sql -dir migrations create_users_table

执行这条命令会创建两个文件，分别是：

1
2
~/codeDir/golangCode/echo-demo # ls migrations/
20190617061102_create_users_table.down.sql  20190617061102_create_users_table.up.sql

20190617061102是和时间有关的一个标识，用来区分我们的migration的版本。

这两个文件都是空的，需要我们自己去填充。很明显，这是两个相反的sql操作。

我们在20190617061102_create_users_table.up.sql中写入创建users表的操作：

1
2
3
4
5
6
CREATE TABLE IF NOT EXISTS users(
   id INT,
   name VARCHAR(100) NOT NULL,
   password VARCHAR(40) NOT NULL,
   PRIMARY KEY ( id )
);

对应的我们就需要在20190617061102_create_users_table.down.sql中删除这张表：

1
DROP table IF EXISTS users;

然后，我们在终端执行命令：

1
migrate -verbose -source file://migrations -database postgres://postgres:postgres用户的密码@host.docker.internal:5432/postgres?sslmode=disable up 1

结果如下：

1
2
3
4
5
6
7
~/codeDir/golangCode/echo-demo # migrate -verbose -source file://migrations -database postgres://postgres:postgres用户的密码@host.docker.internal:5432/postgres?sslmode=disable up 1
2019/06/17 06:17:20 Start buffering 20190617061102/u create_users_table
2019/06/17 06:17:20 Read and execute 20190617061102/u create_users_table
2019/06/17 06:17:20 Finished 20190617061102/u create_users_table (read 11.0414ms, ran 12.0132ms)
2019/06/17 06:17:20 Finished after 28.7139ms
2019/06/17 06:17:20 Closing source and database
~/codeDir/golangCode/echo-demo #

此时，我们看看数据库的表：

1
2
3
4
5
6
7
8
9
postgres=# \dt
               List of relations
 Schema |       Name        | Type  |  Owner   
--------+-------------------+-------+----------
 public | schema_migrations | table | postgres
 public | users             | table | postgres
(2 rows)

postgres=#

发现，此时有两张表，分别是schema_migrations以及我们创建的users。其中，schema_migrations里面存放的是当前migration的版本以及状态。

我们来看看：

1
2
3
4
5
6
7
postgres=# select * from schema_migrations;
    version     | dirty 
----------------+-------
 20190617061102 | f
(1 row)

postgres=#

此时，migration的版本是20190617061102，这个就是我们文件的前缀。dirty代表当前版本是干净的还是脏的。f表示干净（即没有出问题）。

然后，我来演示一下migrate失败的操作。

我们再创建一个migration文件：

1
migrate create -ext sql -dir migrations create_emails_table
1
2
3
~/codeDir/golangCode/echo-demo # ls migrations/
20190617061102_create_users_table.down.sql   20190617061102_create_users_table.up.sql     20190617062220_create_emails_table.down.sql  20190617062220_create_emails_table.up.sql
~/codeDir/golangCode/echo-demo #

然后，在up的那个文件里面写下：

1
2
3
4
5
CREATE TABLE IF NOT EXISTS emails(
   id error INT,
   account VARCHAR(100) NOT NULL,
   PRIMARY KEY ( id )
);

（我们在id的那一行故意写错了，加了一个会导致报错的字符串error）

在down的那个文件里面写下：

1
DROP table IF EXISTS emails;

然后，执行迁移操作：

1
2
3
4
5
6
7
8
9
~/codeDir/golangCode/echo-demo # migrate -verbose -source file://migrations -database postgres://postgres:postgres用户的密码@host.docker.internal:5432/postgres?sslmode=disable up 1
2019/06/17 06:24:49 Start buffering 20190617062220/u create_emails_table
2019/06/17 06:24:49 Read and execute 20190617062220/u create_emails_table
2019/06/17 06:24:49 error: migration failed: syntax error at or near "INT" (column 13) in line 2: CREATE TABLE IF NOT EXISTS emails(
   id error INT,
   account VARCHAR(100) NOT NULL,
   PRIMARY KEY ( id )
); (details: pq: syntax error at or near "INT")
~/codeDir/golangCode/echo-demo #

完美报错。

此时，我们把error这个字符串删除：

1
2
3
4
5
CREATE TABLE IF NOT EXISTS emails(
   id INT,
   account VARCHAR(100) NOT NULL,
   PRIMARY KEY ( id )
);

然后再执行迁移操作：

1
2
3
~/codeDir/golangCode/echo-demo # migrate -verbose -source file://migrations -database postgres://postgres:postgres用户的密码@host.docker.internal:5432/postgres?sslmode=disable up 1
2019/06/17 06:26:36 error: Dirty database version 20190617062220. Fix and force version.
~/codeDir/golangCode/echo-demo #

（开始的时候，我是吃惊的，因为我按照Laravel migrate的思路，不应该会报错）

报错提示说database version是脏的。所以，我们看看schema_migrations表的内容：

1
2
3
4
5
6
7
postgres=# select * from schema_migrations;
    version     | dirty 
----------------+-------
 20190617062220 | t
(1 row)

postgres=#

我们发现，尽管migrate up失败了，但是这里还是会up这个version。这是我用不习惯的一个地方。

此时，我们需要按照报错的提示：

1
Fix and force version.

我们已经把error字符串删除了，所以此时我们只需要force version一下：

1
2
3
~/codeDir/golangCode/echo-demo # migrate -verbose -source file://migrations -database postgres://postgres:postgres用户的密码@host.docker.internal:5432/postgres?sslmode=disable force 20190617062220
2019/06/17 06:32:30 Finished after 18.7548ms
2019/06/17 06:32:30 Closing source and database

force后面带上dirty的那个版本。

此时，我们再看看schema_migrations表的内容：

1
2
3
4
5
6
7
postgres=# select * from schema_migrations;
    version     | dirty 
----------------+-------
 20190617062220 | f
(1 row)

postgres=#

dirty已经是f了，代表这是干净的了。

然后，我们再回退到上一个版本：

1
2
3
4
5
6
7
~/codeDir/golangCode/echo-demo # migrate -verbose -source file://migrations -database postgres://postgres:postgres用户的密码@host.docker.internal:5432/postgres?sslmode=disable down 1
2019/06/17 06:34:04 Start buffering 20190617062220/d create_emails_table
2019/06/17 06:34:04 Read and execute 20190617062220/d create_emails_table
2019/06/17 06:34:04 Finished 20190617062220/d create_emails_table (read 13.2303ms, ran 10.691ms)
2019/06/17 06:34:04 Finished after 30.1489ms
2019/06/17 06:34:04 Closing source and database
~/codeDir/golangCode/echo-demo #

回退成功：

1
2
3
4
5
6
7
postgres=# select * from schema_migrations;
    version     | dirty 
----------------+-------
 20190617061102 | f
(1 row)

postgres=#

然后，我们现在可以正常的执行up操作了：

1
2
3
4
5
6
7
~/codeDir/golangCode/echo-demo # migrate -verbose -source file://migrations -database postgres://postgres:postgres用户的密码@host.docker.internal:5432/postgres?sslmode=disable up 1
2019/06/17 06:35:15 Start buffering 20190617062220/u create_emails_table
2019/06/17 06:35:15 Read and execute 20190617062220/u create_emails_table
2019/06/17 06:35:15 Finished 20190617062220/u create_emails_table (read 12.715ms, ran 16.2358ms)
2019/06/17 06:35:15 Finished after 34.5774ms
2019/06/17 06:35:15 Closing source and database
~/codeDir/golangCode/echo-demo # 
1
2
3
4
5
6
7
8
9
10
postgres=# \dt
               List of relations
 Schema |       Name        | Type  |  Owner   
--------+-------------------+-------+----------
 public | emails            | table | postgres
 public | schema_migrations | table | postgres
 public | users             | table | postgres
(3 rows)

postgres=#

emails表创建完成。

（感觉还是不如Laravel的migrate好用）

codinghuangPHP Developer

PHP开发者~