1
0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-12-18 08:26:45 +02:00
woodpecker/vendor/github.com/BurntSushi/migration/doc.go
2015-09-29 17:34:44 -07:00

21 lines
1.1 KiB
Go

/*
Package migration automatically handles versioning of a database
schema by applying a series of migrations supplied by the client. It uses
features only from the database/sql package, so it tries to be driver
independent. However, to track the version of the database, it is necessary to
execute some SQL. I've made an effort to keep those queries simple, but if they
don't work with your database, you may override them.
This package works by applying a series of migrations to a database. Once a
migration is created, it should never be changed. Every time a database is
opened with this package, all necessary migrations are executed in a single
transaction. If any part of the process fails, an error is returned and the
transaction is rolled back so that the database is left untouched. (Note that
for this to be useful, you'll need to use a database that supports rolling back
changes to your schema. Notably, MySQL does not support this, although SQLite
and PostgreSQL do.)
The version of a database is defined as the number of migrations applied to it.
*/
package migration