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