migrations

package

v0.8.0 Latest Latest Go to latest Published: Mar 10, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Details

This section is empty.

View Source

var (
	ErrInvalidMigrationExt  = errors.New("invalid migration ext")
	ErrInvalidMigrationName = errors.New("invalid migration name")
)

Errors.

View Source

var ErrInvalidVersion = errors.New("invalid version")

View Source

var ErrUnknownCommand = errors.New("unknown command")

func Run(ctx context.Context, driver string, connector database.Connector, cmd Command, migrations Migrations) error

Run execute every 'delimUp' instructions for every migration.

type Command uint8

Command of migration.

const (
	Up   Command // up
	Down         // down
)

Enum.

func (i Command) String() string

type Migration struct {
	Version uint
	Name    string
	Up      string
	Down    string
}

Migration information for UP and Down sql query.

type Migrations []Migration

Migrations for easy sorting list of migrations.

func FromFS(directory fs.FS, root string) (Migrations, error)

FromFS build migrations from file system.

func Parse(path string) (Migrations, error)

Parse and build migrations from disk.

func (m Migrations) Len() int

Len implements sort.Interface.

func (m Migrations) Less(i, j int) bool

Less implements sort.Interface.

func (m Migrations) Swap(i, j int)

Swap implements sort.Interface.