models

Documentation

Index

• Constants
• Variables
• type Direction
• type Migration
  • func NewMigration(migrationBytes io.ReadCloser, fileName string) (*Migration, error)
  • func (m *Migration) Query() string
• type Plan
  • func NewPlan(migrations, rollback []*Migration, auto bool) *Plan
  • func (p *Plan) Validate() error

Constants

const CurrentPlanVersion = 1

Variables

var ErrInvalidPlanVersion = errors.New("invalid plan version")

var (
	ErrParse = fmt.Errorf("no match")
)

var Regex = regexp.MustCompile(`^([0-9]+)_(.*)\.(` + string(Down) + `|` + string(Up) + `)\.(.*)$`)

Regex matches the following pattern:

123_name.up.ext
123_name.down.ext

Types

type Direction

type Direction string

Direction is either up or down.

const (
	Down Direction = "down"
	Up   Direction = "up"
)

type Migration

type Migration struct {
	Bytes     []byte
	Name      string
	RawName   string
	Version   uint32
	Direction Direction
}

func NewMigration

func NewMigration(migrationBytes io.ReadCloser, fileName string) (*Migration, error)

func (*Migration) Query

func (m *Migration) Query() string

type Plan

type Plan struct {
	// Version is the version of the plan.
	Version int
	// Auto is the mode of the plan. If true, the plan will rollback automatically in case of an error.
	Auto bool
	// Migrations is the list of migrations to be applied.
	Migrations []*Migration
	// RevertMigrations is the list of migrations to be applied in case of an error.
	RevertMigrations []*Migration
}

func NewPlan

func NewPlan(migrations, rollback []*Migration, auto bool) *Plan

func (*Plan) Validate

func (p *Plan) Validate() error