update documentation

pull/120/head
1vn 2018-11-06 16:54:31 -05:00
parent a4a53bdf99
commit 90f0cf504b
3 changed files with 13 additions and 8 deletions

View File

@ -22,9 +22,7 @@ Goose is a database migration tool. Manage your database schema by creating incr
- goose pkg doesn't register any SQL drivers anymore, - goose pkg doesn't register any SQL drivers anymore,
thus no driver `panic()` conflict within your codebase! thus no driver `panic()` conflict within your codebase!
- goose pkg doesn't have any vendor dependencies anymore - goose pkg doesn't have any vendor dependencies anymore
- We encourage using sequential versioning of migration files - We use timestamped migrations by default but recommend a hybrid approach of using timestamps in the development process and sequential versions in production.
(rather than timestamps-based versioning) to prevent version
mismatch and migration colissions
# Install # Install
@ -51,7 +49,7 @@ Commands:
redo Re-run the latest migration redo Re-run the latest migration
status Dump the migration status for the current DB status Dump the migration status for the current DB
version Print the current version of the database version Print the current version of the database
create NAME [sql|go] Creates new migration file with next version create NAME [sql|go] Creates new migration file with the current timestamp
Options: Options:
-dir string -dir string
@ -74,14 +72,14 @@ Examples:
Create a new SQL migration. Create a new SQL migration.
$ goose create add_some_column sql $ goose create add_some_column sql
$ Created new file: 00001_add_some_column.sql $ Created new file: 20170506082420_add_some_column.sql
Edit the newly created file to define the behavior of your migration. Edit the newly created file to define the behavior of your migration.
You can also create a Go migration, if you then invoke it with [your own goose binary](#go-migrations): You can also create a Go migration, if you then invoke it with [your own goose binary](#go-migrations):
$ goose create fetch_user_data go $ goose create fetch_user_data go
$ Created new file: 00002_fetch_user_data.go $ Created new file: 20170506082421_fetch_user_data.go
## up ## up
@ -241,6 +239,11 @@ func Down(tx *sql.Tx) error {
} }
``` ```
# Hybrid Versioning
We strongly recommend adopting a hybrid versioning approach, using both timestamps and sequential numbers. Migrations created during the development process are timestamped and sequential versions are ran on production. We believe this method will prevent the problem of conflicting versions when writing software in a team environment.
To help you adopt this approach, `create` will use the current timestamp as the migration version. When you're ready to deploy your migrations in a production environment, we also provide a helpful `fix` command to convert your migrations into sequential order, while preserving the timestamp ordering. We recommend running `fix` in the CI pipeline, and only when the migrations are ready for production.
## License ## License
Licensed under [MIT License](./LICENSE) Licensed under [MIT License](./LICENSE)

View File

@ -125,6 +125,7 @@ Commands:
reset Roll back all migrations reset Roll back all migrations
status Dump the migration status for the current DB status Dump the migration status for the current DB
version Print the current version of the database version Print the current version of the database
create NAME [sql|go] Creates new migration file with next version create NAME [sql|go] Creates new migration file with the current timestamp
fix Apply sequential ordering to migrations
` `
) )

View File

@ -125,6 +125,7 @@ Commands:
redo Re-run the latest migration redo Re-run the latest migration
status Dump the migration status for the current DB status Dump the migration status for the current DB
version Print the current version of the database version Print the current version of the database
create NAME [sql|go] Creates new migration file with next version create NAME [sql|go] Creates new migration file with the current timestamp
fix Apply sequential ordering to migrations
` `
) )