https://github.com/tcfw/go-migrate
Stupidly simple SQL migrations
https://github.com/tcfw/go-migrate
database database-migrations go golang golang-package migrations sql
Last synced: 14 days ago
JSON representation
Stupidly simple SQL migrations
- Host: GitHub
- URL: https://github.com/tcfw/go-migrate
- Owner: tcfw
- License: mit
- Created: 2020-09-21T00:34:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-16T00:38:04.000Z (about 5 years ago)
- Last Synced: 2025-02-24T16:51:14.580Z (about 1 year ago)
- Topics: database, database-migrations, go, golang, golang-package, migrations, sql
- Language: Go
- Homepage:
- Size: 38.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# go-migrate
[](https://pkg.go.dev/github.com/tcfw/go-migrate) [](https://goreportcard.com/report/github.com/tcfw/go-migrate)
Stupidly simple SQL migrations
Migrations should be packages with your binary, so why not codify them!
## Example migration
```go
//your-package/migrations/2020_09_21_115238_create_users_table.go
package migrations
import (
"database/sql"
"time"
"github.com/tcfw/go-migrate"
)
func init() {
register(migrate.NewSimpleMigration(
//Migration name to use in DB
"create_users_table",
//Timestamp of migration
time.Date(2020, 9, 21, 11, 52, 38, 0, time.Local),
//Up
func(tx *sql.Tx) error {
_, err := tx.Exec(`CREATE TABLE users (
id UUID PRIMARY KEY,
email string
)`)
return err
},
//Down
func(tx *sql.Tx) error {
_, err := tx.Exec(`DROP TABLE users`)
return err
},
))
}
```
```go
//your-package/migrations/migrations.go
package migrations
import (
"database/sql"
"github.com/sirupsen/logrus"
"github.com/tcfw/go-migrate"
)
//migs List of known migrations
var migs migrate.MigrationList = migrate.MigrationList{}
//register helper to register migrations from init
func register(mig migrate.Migration) {
migs = append(migs, mig)
}
//Migrate runs migrations up (run in main or init)
func Migrate(db *sql.DB, log *logrus.Logger) error {
return migrate.Migrate(db, log, migs)
}
```
### Notes
- File names are irrelevant which is why name and date are in the migration struct (possibly fix in future)
- There's no auto migrate down like there is for up as increments aren't stored in groups (like in for example Laravel migrations in PHP) and it is assumed that if you are migrating down, it should probably be a manual process anyway
- There is no DB table locking.
- Any failures rollback the TX of the total increment over **multiple** migrations