Simple migration capabilities for any Go backend

Aneurin Barker Snook c3687e17e0 add test workflow hace 1 año
.github c3687e17e0 add test workflow hace 1 año
.gitignore 97bce22b38 initial working version hace 1 año
LICENSE.md ef8ff4b25d add readme hace 1 año
README.md ef8ff4b25d add readme hace 1 año
error.go 97bce22b38 initial working version hace 1 año
func_migration.go ef8ff4b25d add readme hace 1 año
go.mod ef8ff4b25d add readme hace 1 año
interfaces.go 97bce22b38 initial working version hace 1 año
module.go 97bce22b38 initial working version hace 1 año
module_test.go 97bce22b38 initial working version hace 1 año

README.md

Migres

This package provides simple migration capabilities for any backend.

System requirements

Basic usage

The key type in this package is Module which allows mapping version strings to Migration interfaces. For example:

import "github.com/annybs/migres"

type MyBackend struct{}

func (mb *MyBackend) Module() migres.Module {
  return migres.Module{
    "1.0.0": migres.Func(mb.upgradeV1, mb.downgradeV1),
    "2.0.0": migres.Func(mb.upgradeV2, mb.downgradeV2),
  }
}

Call Module.Upgrade(from, to) or Module.Downgrade(from, to) in order to execute migrations. The module ensures migrations are all run in the correct order.

License

See LICENSE.md