https://github.com/nate-anderson/moogration
Simple MySQL migrations in Go
https://github.com/nate-anderson/moogration
database go golang migrations mysql sql
Last synced: 3 months ago
JSON representation
Simple MySQL migrations in Go
- Host: GitHub
- URL: https://github.com/nate-anderson/moogration
- Owner: nate-anderson
- License: mit
- Created: 2020-09-13T06:22:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-30T03:52:18.000Z (over 1 year ago)
- Last Synced: 2025-11-29T23:51:46.560Z (4 months ago)
- Topics: database, go, golang, migrations, mysql, sql
- Language: Go
- Homepage:
- Size: 112 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# moogration
Simple MySQL migrations in Go. No dependencies, simple API, migration change detection and
status tracking, and a cute cow.
It might work with other SQL databases, but I haven't tried. I wrote this as part of another
project and put it in this repo for my own convenience of reuse. I doubt it's ready for
production.
## Defining migrations
Migrations should be defined using the `Migration` struct type and registered using the
`Register` function, like so:
```go
moogration.Register(
&Migration{
Name: "001_create_table_user",
Up: `CREATE TABLE user (
...
);`,
Down: `DROP TABLE user;`,
}
)
```
## Running migrations
Migrations registered with `Register` will be sorted ascending by the `name` key
and run in order. Previously run migrations will be skipped unless `force` is set to true.
```go
moogration.RunLatest(db, down, force, logger)
```
You can also roll back a specified number of migration batches with `moogration.Rollback()`.
## Logging
Pass a `*log.Logger` to log migration status. Pass `nil` to silence migration logging.
## Errors
This package assumes that database migrations are application critical and thus panics upon
encountering an error.