An abstract task migration tool written in Go for Go services. Database and non database migrations management brought to your CLI.
The motivation behind creating this tool, is to abstract away the database part. If your task can be completed with Pure Go or via a Go driver of your service, then this is for you. Since it makes use of the Go runtime, you can even perform database migrations like PostgreSQL, Mongo, Redis, Elasticsearch, GCP Buckets etc. You just need to be able to interact with your data store or complete your task using Go.
The main use case is when you won't be able to do everything with SQL or No-SQL syntax. There might be some tasks where you need to aggregate data, iterate over them, and do business related computation. All you need to know is Go syntax and write a Go program.
go get github.com/g14a/metanabrew tap g14a/homebrew-metana
brew install metanaCheckout the releases page and download your platform's binaries to install them.
Prerequisites:
- Git
- Go 1.13 or newer. Go modules are needed. Better if its the latest version.
git clone https://github.com/g14a/metana
cd metana
go installAfter installation, let's just hit metana on the terminal.
$ metana
An abstract migration tool for Go services
Usage:
metana [flags]
metana [command]
Available Commands:
completion Generate shell completion script
config Manage your local metana config in .metana.yml
create Create a migration in Go
down Run downward migrations
help Help about any command
init Initialize a migrations directory
list List existing migrations
up Run upward migrations
Flags:
--config string config gen (default is $HOME/.metana.yaml)
-h, --help help for metana
-t, --toggle Help message for toggle
Use "metana [command] --help" for more information about a command.init initializes a boilerplate migrations directory in your current path.
$ metana init
Successfully initialized migration setup in migrationscreate creates a migration script with two functions Up() and Down() denoting the upward and downward migration of the same.
$ metana create initSchema
✓ Created migrations/scripts/1746334029_initSchema.goHead over to your 1745742878_initSchema.go to edit your script. Remember to not change any function signature.
up runs all the upward migrations in the migrations directory in order of their creation time.
$ metana up
InitSchema up
__COMPLETE__[up]: 1745742878_initSchema.go
InitSchema2 up
__COMPLETE__[up]: 1745742917_initSchema2.go
>>> migration : completedown runs the downward migrations in the reverse order of creation time because we're trying to undo the upward migrations.
$ metana down
InitSchema down
__COMPLETE__[down]: 1745742878_initSchema.go
InitSchema2 down
__COMPLETE__[down]: 1745742917_initSchema2.go
>>> migration : completelist lists all the migrations present in your migrations folder along with the last executed time.
$ metana list
+---------------------------+------------------+
| MIGRATION | EXECUTED AT |
+---------------------------+------------------+
| 1745742878_initSchema.go | 27-04-2025 14:06 |
| 1745742917_initSchema2.go | 27-04-2025 14:06 |
+---------------------------+------------------+Run upward and downward migrations until(and including) a certain migration with the --until flag.
$ metana create initSchema
✓ Created migrations/scripts/1746334029_initSchema.go
$ Create more migration scripts...
$ metana list
+---------------------------+------------------+
| MIGRATION | EXECUTED AT |
+---------------------------+------------------+
| 1745743242_initSchema.go | |
| 1745743245_initSchema2.go | |
| 1745743247_initSchema3.go | |
+---------------------------+------------------+
$ metana up --until initSchema2
InitSchema up
__COMPLETE__[up]: 1745743242_initSchema.go
InitSchema2 up
__COMPLETE__[up]: 1745743245_initSchema2.go
>>> Reached --until: initSchema2. Stopping further migrations.
>>> migration : completeStore and track your migrations in your favourite database by passing the --store flag.
metana up --store <db-connection-url>If your connection URL is store in an environment variable you can pass it as --store @MONGO_URL and it will automatically be picked up from your environment.
Right now, PostgreSQL(which means even CockroachDB URLs) and MongoDB are supported to store migrations.
If no --store flag is passed, migrations will be stored in a default migrate.json file in the migrations directory.
Dry run your migrations using the --dry flag.
You can dry run your migrations using the explicit --dry option. This option doesn't track any migrations, doesn't create a default migrate.json file. It literally just dry runs. However your tasks are run. This helps when you're incrementally writing, testing and running your functions instead of manually deleting states in your store.
$ metana up --dry
InitSchema up
__COMPLETE__[up]: 1745743242_initSchema.go
InitSchema2 up
__COMPLETE__[up]: 1745743245_initSchema2.go
InitSchema3 up
__COMPLETE__[up]: 1745743247_initSchema3.go
>>> dry run migration : complete$ metana down --dry
InitSchema down
__COMPLETE__[down]: 1745743242_initSchema.go
InitSchema2 down
__COMPLETE__[down]: 1745743245_initSchema2.go
InitSchema3 down
__COMPLETE__[down]: 1745743247_initSchema3.go
>>> dry run migration : completeAll the other options like --dir and --until work along with --dry.
Metana automatically handles rollback during upward migrations (metana up)
If an upward migration (up) fails while being run, Metana will immediately trigger the downward migration (down) of that same migration file to rollback the changes and restore consistency.
You don't have to manually clean up — rollback is automatic. But you still have implement the logic of the downward migration.
Example:
$ metana up
InitSchema up
__COMPLETE__[up]: 1745748076_initSchema.go
Migration 1745748078_initSchema2.go failed, attempting rollback...
InitSchema2 down
__COMPLETE__[down]: 1745748078_initSchema2.go
>>> migration : complete
2025/04/27 15:32:05 migration 1745748078_initSchema2.go failed: execution error: exit status 1
error: simulated error
goroutine 1 [running]:
runtime/debug.Stack()
/Users/gowtham.munukutla/.gvm/gos/go1.21/src/runtime/debug/stack.go:24 +0x64
runtime/debug.PrintStack()
/Users/gowtham.munukutla/.gvm/gos/go1.21/src/runtime/debug/stack.go:16 +0x1c
main.main()
/Users/gowtham.munukutla/metana/migrations/scripts/1745748078_initSchema2.go:48 +0x1d8
exit status 1