migrate

迁移

数据库迁移写在GO中。用作CLI或导入作为库。

• 迁移读取从来源迁移，并以正确的顺序应用到数据库。
• 驾驶员是“愚蠢的”，将所有东西迁移在一起，并确保逻辑是防弹的。 （也可以使驾驶员轻巧。）
• 数据库驱动程序不假设事物或尝试纠正用户输入。如有疑问，失败。

从哑光/迁移中分叉

数据库

数据库驱动程序运行迁移。添加新数据库？

• Postgresql
• PGX V4
• PGX V5
• 红移
• QL
• Cassandra / Scylladb
• sqlite
• sqlite3（todo＃165）
• sqlcipher
• mysql / mariadb
• neo4j
• mongodb
• cratedb（todo＃170）
• 壳（Todo＃171）
• Google Cloud Spanner
• 蟑螂
• Yugabytedb
• Clickhouse
• 火鸟
• MS SQL Server
• rqlite

数据库URL

数据库连接字符串是通过URL指定的。 URL格式取决于驱动程序，但通常具有： dbdriver://username:password@host:port/dbname?param1=true&param2=false

任何保留的URL字符都需要逃脱。请注意， %字符也需要逃脱

明确地，需要逃脱以下字符： ! ， # ， $ ， % ， & ' ， ( ， ) ， * ， + , / ， : ,， ; ， = ? ， @ ， [ ， ]

始终运行DB连接URL（例如用户名，密码等）的URL部分最容易通过URL编码器运行。请参阅下面的示例python摘要：

$ python3 -c ' import urllib.parse; print(urllib.parse.quote(input("String to encode: "), "")) '
String to encode: FAKEpassword!#$%&' () * +,/:;= ? @[]
FAKEpassword%21%23%24%25%26%27%28%29%2A%2B%2C%2F%3A%3B%3D%3F%40%5B%5D
$ python2 -c ' import urllib; print urllib.quote(raw_input("String to encode: "), "") '
String to encode: FAKEpassword!#$%&' () * +,/:;= ? @[]
FAKEpassword%21%23%24%25%26%27%28%29%2A%2B%2C%2F%3A%3B%3D%3F%40%5B%5D
$

迁移来源

源驱动程序从本地或远程来源读取迁移。添加新来源？

• 文件系统 - 从文件系统中读取
• io/fs-从go io/fs阅读
• go-bindata-从嵌入式二进制数据（jteeuwen/go-bindata）中读取
• PKGER-从嵌入式二进制数据（Markbates/Pkger）中读取
• GitHub-从远程GitHub存储库中读取
• GitHub Enterprise-从远程GitHub企业存储库中读取
• Bitbucket-从远程Bitbucket存储库中读取
• GitLab-从远程GitLab存储库中阅读
• AWS S3-从Amazon Web服务读取S3
• Google云存储 - 从Google云平台存储中阅读

CLI用法

• 这个库周围的简单包装器。
• 优雅地处理Ctrl+C（Sigint）。
• 没有配置搜索路径，没有配置文件，没有魔术env var注射。

CLI文档

基本用法

$ migrate -source file://path/to/migrations -database postgres://localhost:5432/database up 2

Docker用法

$ docker run -v {{ migration dir }}:/migrations --network host migrate/migrate
    -path=/migrations/ -database postgres://localhost:5432/database up 2

在您的GO项目中使用

• API稳定并冻结了此版本（V3＆V4）。
• 使用GO模块来管理依赖关系。
• 为了帮助防止数据库腐败，它通过GracefulStop chan bool支持优雅的停止。
• 带上自己的记录仪。
• 内部使用io.Reader流以低内存开销。
• 螺纹安全，没有gor泄漏。

去文档

 import (
    "github.com/golang-migrate/migrate/v4"
    _ "github.com/golang-migrate/migrate/v4/database/postgres"
    _ "github.com/golang-migrate/migrate/v4/source/github"
)

func main () {
    m , err := migrate . New (
        "github://mattes:personal-access-token@mattes/migrate_test" ,
        "postgres://localhost:5432/database?sslmode=enable" )
    m . Steps ( 2 )
}

想使用现有数据库客户端吗？

 import (
    "database/sql"
    _ "github.com/lib/pq"
    "github.com/golang-migrate/migrate/v4"
    "github.com/golang-migrate/migrate/v4/database/postgres"
    _ "github.com/golang-migrate/migrate/v4/source/file"
)

func main () {
    db , err := sql . Open ( "postgres" , "postgres://localhost:5432/database?sslmode=enable" )
    driver , err := postgres . WithInstance ( db , & postgres. Config {})
    m , err := migrate . NewWithDatabaseInstance (
        "file:///migrations" ,
        "postgres" , driver )
    m . Up () // or m.Steps(2) if you want to explicitly set the number of migrations to run
}

入门

开始

教程

• 蟑螂
• Postgresql

（更多教程将来）

迁移文件

每个迁移都有上下迁移。为什么？

1481574547_create_users_table.up.sql
1481574547_create_users_table.down.sql

最佳实践：如何写迁移。

来自另一个数据库迁移工具？

查看偏头痛者。注意：偏头痛者没有该项目的隶属关系或支持

版本

版本	支持？	进口	笔记
掌握	✅	import "github.com/golang-migrate/migrate/v4"	新功能和错误修复首先到达这里
v4	✅	import "github.com/golang-migrate/migrate/v4"	用于稳定版本
V3		import "github.com/golang-migrate/migrate" （包装经理）或import "gopkg.in/golang-migrate/migrate.v3" （不建议）	不要使用- 不再支持

发展和贡献

是的，请！ Makefile是您的朋友，请阅读《开发指南》。

还要看看常见问题解答。

---

寻找替代方案？ https://awesome-go.com/#database。