lightmigrate

type Direction string

type DriverError struct {
	// Optional: the line number
	Line uint

	// Query is a query excerpt
	Query []byte

	// Msg is a useful/helping error message for humans
	Msg string

	// OrigErr is the underlying error
	OrigErr error
}

type ErrDuplicateMigration struct {
	os.FileInfo
	// contains filtered or unexported fields
}

type Logger interface {
	// Printf is like fmt.Printf
	Printf(format string, v ...interface{})
}

type MigrationDriver interface {
	io.Closer

	// Lock should acquire a database lock so that only one migration process
	// can run at a time. Migrate will call this function before Run is called.
	// If the implementation can't provide this functionality, return nil.
	// Return database.ErrLocked if database is already locked.
	Lock() error

	// Unlock should release the lock. Migrate will call this function after
	// all migrations have been run.
	Unlock() error

	// GetVersion returns the currently active version and the database dirty state.
	// When no migration has been applied, it must return version NoMigrationVersion (0).
	// Dirty means, a previous migration failed and user interaction is required.
	GetVersion() (version uint64, dirty bool, err error)

	// SetVersion saves version and dirty state.
	// Migrate will call this function before and after each call to RunMigration.
	// version must be >= 1. 0 means NoMigrationVersion.
	SetVersion(version uint64, dirty bool) error

	// RunMigration applies a migration to the database. migration is guaranteed to be not nil.
	RunMigration(migration io.Reader) error

	// Reset deletes everything related to LightMigrate in the database.
	Reset() error
}

type MigrationSource interface {
	io.Closer

	// First returns the very first migration version available.
	// If there is no version available, it must return os.ErrNotExist.
	First() (version uint64, err error)

	// Prev returns the previous version for a given version.
	// If there is no previous version available, it must return os.ErrNotExist.
	Prev(version uint64) (prevVersion uint64, err error)

	// Next returns the next version for a given version.
	// If there is no next version available, it must return os.ErrNotExist.
	Next(version uint64) (nextVersion uint64, err error)

	// ReadUp returns the UP migration body and an identifier that helps
	// finding this migration in the source for a given version.
	// If there is no up migration available for this version,
	// it must return os.ErrNotExist.
	ReadUp(version uint64) (r io.ReadCloser, identifier string, err error)

	// ReadDown returns the DOWN migration body and an identifier that helps
	// finding this migration in the source for a given version.
	// If there is no down migration available for this version,
	// it must return os.ErrNotExist.
	ReadDown(version uint64) (r io.ReadCloser, identifier string, err error)
}

type Migrator interface {
	Migrate(version uint64) error
}

type MigratorOption func(svc *migrator)