文件列表:

.drone.yml (214, 2017-12-19)
.travis.yml (38, 2017-12-19)
LICENSE (1071, 2017-12-19)
Makefile (83, 2017-12-19)
TODO.md (181, 2017-12-19)
adapter.go (1048, 2017-12-19)
adapter_test.go (1693, 2017-12-19)
adapters/ (0, 2017-12-19)
adapters/sql/ (0, 2017-12-19)
adapters/sql/adapter.go (3827, 2017-12-19)
cmd/ (0, 2017-12-19)
cmd/cmd.go (2482, 2017-12-19)
examples/ (0, 2017-12-19)
examples/docker-compose.yml (193, 2017-12-19)
examples/example.go (952, 2017-12-19)
filesystem.go (1171, 2017-12-19)
filesystem_test.go (2327, 2017-12-19)
marshal_options.go (567, 2017-12-19)
migrataur.go (10317, 2017-12-19)
migrataur_test.go (8283, 2017-12-19)
migration.go (2620, 2017-12-19)
migration_test.go (1511, 2017-12-19)
options.go (2400, 2017-12-19)
options_test.go (1360, 2017-12-19)
utils_test.go (2024, 2017-12-19)

# migrataur : a migration library for Go [](https://travis-ci.org/YuukanOO/migrataur) [](https://goreportcard.com/report/github.com/YuukanOO/migrataur) [](https://gocover.io/github.com/YuukanOO/migrataur) **migrataur** is a simple and easy to understand library to manage database migrations in Go. It exposes a simple API that you can use in your own application. A CLI is also at your disposal and was written using [urfave/cli](https://github.com/urfave/cli), have a look at the [example](examples/example.go) to find out how to use it. ## Documentation ### Library Documentation is available at [godoc](https://godoc.org/github.com/YuukanOO/migrataur) but here is a sneak peak: ```go package main import ( "database/sql" "github.com/YuukanOO/migrataur" adapter "github.com/YuukanOO/migrataur/adapters/sql" _ "github.com/lib/pq" ) func main() { db, _ := sql.Open("postgres", "postgres://pqgotest:pqgotest@localhost/pqgotest?sslmode=disable") // In a real application, you should catch errors... defer db.Close() // Instantiates a new migrataur. Have a look at Options, almost everything is // configurable so it can be used for many backend instance := migrataur.New(adapter.WithDBAndOptions(db, adapter.DefaultTableName, "${i}"), migrataur.DefaultOptions) // Generates migration needed by the adapter, you should always call it ONCE // when starting a new project. The adapter will writes the migration that it // needs to work properly. instance.Init() // Creates a new migration and write it to the filesystem, the actual name will // be generated using the configurated SequenceGenerator and Extension instance.New("migration01") instance.New("migration02") instance.New("migration03") // Apply one instance.Migrate("migration01") // Or a range instance.Migrate("migration01..migration02") // Or every pending ones instance.MigrateToLatest() // Same for rollbacking instance.Rollback("migration02") instance.Rollback("migration02..migration01") instance.Reset() // Retrieve all migrations and if they were applied or not instance.GetAll() // If you want to remove migrations, call Remove. It will // rollback them and delete generated files. instance.Remove("migration03") instance.Remove("migration02..migration01") } ``` ### Command Check [example.go](examples/example.go). Run the `docker-compose up -d` to starts the database used to test and then `go run example.go` to check available commands. ### But wait, how do I write migrations? It depends on your instance configuration since you can override extension and up and down delimiters. The default configuration assumes an extension of `.sql` and contains something like this: ```sql -- +migrataur up create table Movies ( ID int generated always as identity primary key, Name varchar(50) ); insert into Movies (Name) values ('Film 1'), ('Film 2'), ('Film 3') -- -migrataur up -- +migrataur down drop table Movies; -- -migrataur down ``` ## Adapters Adapters are what makes **migrataur** database agnostic. It's a simple interface to implement: ```go type Adapter interface { GetInitialMigration() (up, down string) MigrationApplied(migration *Migration) error MigrationRollbacked(migration *Migration) error Exec(command string) error GetAll() ([]*Migration, error) } ``` For now, a generic sql adapter has been written. It you want to provide an adapter implementation, feel free to contribute! ## Contributing Contribution are much appreciated! Feel free to fork this project, pull requests are welcome.

近期下载者：

相关文件：

评论：[我要评论] [举报此文件]

收藏者：