github.com/bishtawi/migrate/v4@v4.8.11/README.md (about) 1 [](https://travis-ci.com/golang-migrate/migrate) 2 [](https://godoc.org/github.com/golang-migrate/migrate) 3 [](https://coveralls.io/github/golang-migrate/migrate?branch=master) 4 [](https://packagecloud.io/golang-migrate/migrate?filter=debs) 5 [](https://hub.docker.com/r/migrate/migrate/) 6  7 [](https://github.com/golang-migrate/migrate/releases) 8 [](https://goreportcard.com/report/github.com/golang-migrate/migrate) 9 10 # migrate 11 12 __Database migrations written in Go. Use as [CLI](#cli-usage) or import as [library](#use-in-your-go-project).__ 13 14 * Migrate reads migrations from [sources](#migration-sources) 15 and applies them in correct order to a [database](#databases). 16 * Drivers are "dumb", migrate glues everything together and makes sure the logic is bulletproof. 17 (Keeps the drivers lightweight, too.) 18 * Database drivers don't assume things or try to correct user input. When in doubt, fail. 19 20 Forked from [mattes/migrate](https://github.com/mattes/migrate) 21 22 ## Databases 23 24 Database drivers run migrations. [Add a new database?](database/driver.go) 25 26 * [PostgreSQL](database/postgres) 27 * [Redshift](database/redshift) 28 * [Ql](database/ql) 29 * [Cassandra](database/cassandra) 30 * [SQLite](database/sqlite3) ([todo #165](https://github.com/mattes/migrate/issues/165)) 31 * [MySQL/ MariaDB](database/mysql) 32 * [Neo4j](database/neo4j) 33 * [MongoDB](database/mongodb) 34 * [CrateDB](database/crate) ([todo #170](https://github.com/mattes/migrate/issues/170)) 35 * [Shell](database/shell) ([todo #171](https://github.com/mattes/migrate/issues/171)) 36 * [Google Cloud Spanner](database/spanner) 37 * [CockroachDB](database/cockroachdb) 38 * [ClickHouse](database/clickhouse) 39 * [Firebird](database/firebird) 40 * [MS SQL Server](database/sqlserver) 41 42 ### Database URLs 43 44 Database connection strings are specified via URLs. The URL format is driver dependent but generally has the form: `dbdriver://username:password@host:port/dbname?option1=true&option2=false` 45 46 Any [reserved URL characters](https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_reserved_characters) need to be escaped. Note, the `%` character also [needs to be escaped](https://en.wikipedia.org/wiki/Percent-encoding#Percent-encoding_the_percent_character) 47 48 Explicitly, the following characters need to be escaped: 49 `!`, `#`, `$`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `:`, `;`, `=`, `?`, `@`, `[`, `]` 50 51 It's easiest to always run the URL parts of your DB connection URL (e.g. username, password, etc) through an URL encoder. See the example Python snippets below: 52 53 ```bash 54 $ python3 -c 'import urllib.parse; print(urllib.parse.quote(input("String to encode: "), ""))' 55 String to encode: FAKEpassword!#$%&'()*+,/:;=?@[] 56 FAKEpassword%21%23%24%25%26%27%28%29%2A%2B%2C%2F%3A%3B%3D%3F%40%5B%5D 57 $ python2 -c 'import urllib; print urllib.quote(raw_input("String to encode: "), "")' 58 String to encode: FAKEpassword!#$%&'()*+,/:;=?@[] 59 FAKEpassword%21%23%24%25%26%27%28%29%2A%2B%2C%2F%3A%3B%3D%3F%40%5B%5D 60 $ 61 ``` 62 63 ## Migration Sources 64 65 Source drivers read migrations from local or remote sources. [Add a new source?](source/driver.go) 66 67 * [Filesystem](source/file) - read from filesystem 68 * [Go-Bindata](source/go_bindata) - read from embedded binary data ([jteeuwen/go-bindata](https://github.com/jteeuwen/go-bindata)) 69 * [Github](source/github) - read from remote Github repositories 70 * [Github Enterprise](source/github_ee) - read from remote Github Enterprise repositories 71 * [Gitlab](source/gitlab) - read from remote Gitlab repositories 72 * [AWS S3](source/aws_s3) - read from Amazon Web Services S3 73 * [Google Cloud Storage](source/google_cloud_storage) - read from Google Cloud Platform Storage 74 75 ## CLI usage 76 77 * Simple wrapper around this library. 78 * Handles ctrl+c (SIGINT) gracefully. 79 * No config search paths, no config files, no magic ENV var injections. 80 81 __[CLI Documentation](cmd/migrate)__ 82 83 ### Basic usage 84 85 ```bash 86 $ migrate -source file://path/to/migrations -database postgres://localhost:5432/database up 2 87 ``` 88 89 ### Docker usage 90 91 ```bash 92 $ docker run -v {{ migration dir }}:/migrations --network host migrate/migrate 93 -path=/migrations/ -database postgres://localhost:5432/database up 2 94 ``` 95 96 ## Use in your Go project 97 98 * API is stable and frozen for this release (v3 & v4). 99 * Uses [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) to manage dependencies. 100 * To help prevent database corruptions, it supports graceful stops via `GracefulStop chan bool`. 101 * Bring your own logger. 102 * Uses `io.Reader` streams internally for low memory overhead. 103 * Thread-safe and no goroutine leaks. 104 105 __[Go Documentation](https://godoc.org/github.com/golang-migrate/migrate)__ 106 107 ```go 108 import ( 109 "github.com/golang-migrate/migrate/v4" 110 _ "github.com/golang-migrate/migrate/v4/database/postgres" 111 _ "github.com/golang-migrate/migrate/v4/source/github" 112 ) 113 114 func main() { 115 m, err := migrate.New( 116 "github://mattes:personal-access-token@mattes/migrate_test", 117 "postgres://localhost:5432/database?sslmode=enable") 118 m.Steps(2) 119 } 120 ``` 121 122 Want to use an existing database client? 123 124 ```go 125 import ( 126 "database/sql" 127 _ "github.com/lib/pq" 128 "github.com/golang-migrate/migrate/v4" 129 "github.com/golang-migrate/migrate/v4/database/postgres" 130 _ "github.com/golang-migrate/migrate/v4/source/file" 131 ) 132 133 func main() { 134 db, err := sql.Open("postgres", "postgres://localhost:5432/database?sslmode=enable") 135 driver, err := postgres.WithInstance(db, &postgres.Config{}) 136 m, err := migrate.NewWithDatabaseInstance( 137 "file:///migrations", 138 "postgres", driver) 139 m.Steps(2) 140 } 141 ``` 142 143 ## Getting started 144 145 Go to [getting started](GETTING_STARTED.md) 146 147 ## Tutorials 148 149 - [CockroachDB](database/cockroachdb/TUTORIAL.md) 150 - [PostgreSQL](database/postgres/TUTORIAL.md) 151 152 (more tutorials to come) 153 154 ## Migration files 155 156 Each migration has an up and down migration. [Why?](FAQ.md#why-two-separate-files-up-and-down-for-a-migration) 157 158 ```bash 159 1481574547_create_users_table.up.sql 160 1481574547_create_users_table.down.sql 161 ``` 162 163 [Best practices: How to write migrations.](MIGRATIONS.md) 164 165 ## Versions 166 167 Version | Supported? | Import | Notes 168 --------|------------|--------|------ 169 **master** | :white_check_mark: | `import "github.com/golang-migrate/migrate/v4"` | New features and bug fixes arrive here first | 170 **v4** | :white_check_mark: | `import "github.com/golang-migrate/migrate/v4"` | Used for stable releases | 171 **v3** | :x: | `import "github.com/golang-migrate/migrate"` (with package manager) or `import "gopkg.in/golang-migrate/migrate.v3"` (not recommended) | **DO NOT USE** - No longer supported | 172 173 ## Development and Contributing 174 175 Yes, please! [`Makefile`](Makefile) is your friend, 176 read the [development guide](CONTRIBUTING.md). 177 178 Also have a look at the [FAQ](FAQ.md). 179 180 --- 181 182 Looking for alternatives? [https://awesome-go.com/#database](https://awesome-go.com/#database).