migration

package module

v0.5.3 Latest Latest Go to latest Published: Aug 12, 2022 License: MIT Imports: 11 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Item struct {
	ID   string
	Hash string
}

type Migration struct {
	// contains filtered or unexported fields
}

func New(source embed.FS) *Migration

New return new Migration object.

source must contains exactly one directory, and that directory must contains only *.sql file. each sql file must have lowercase name.

the migration is sorted by sql file name.

func (m *Migration) All() []Item

func (m *Migration) Check(target string) ([]string, error)

Check the current state of the database.

will return list of migration that need to be executed.

also will return *MismatchHashError error if the database already execute a migration file but it has different hash with source.

func (m *Migration) Run(target string) ([]string, error)

Run the migration.

will return list of migration that executed.

also will return *MismatchHashError error if the database already execute a migration file but it has different hash with source.

func (m *Migration) UnsafeMarkAsExecued(target string, id string) error

type MismatchHashError struct {
	Item
	HashInDB string
}

func (d *MismatchHashError) Error() string