source

Documentation

Index

• Variables
• func Register(name string, driver Driver)
• type Direction
• type Driver
  • func Open(url string) (Driver, error)
• type Migration
  • func Parse(raw string) (*Migration, error)
• type Migrations
  • func NewMigrations() *Migrations
  • func (i *Migrations) Append(m *Migration) (ok bool)
  • func (i *Migrations) Down(version uint) (m *Migration, ok bool)
  • func (i *Migrations) First() (version uint, ok bool)
  • func (i *Migrations) Next(version uint) (nextVersion uint, ok bool)
  • func (i *Migrations) Prev(version uint) (prevVersion uint, ok bool)
  • func (i *Migrations) Up(version uint) (m *Migration, ok bool)

Variables

var DefaultParse = Parse

var DefaultRegex = Regex

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

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

filename example: `123_name.up.ext` filename example: `123_name.down.ext`

Functions

func Register

func Register(name string, driver Driver)

Types

type Direction

type Direction string

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

type Driver

type Driver interface {
	Open(url string) (Driver, error)

	Close() error

	First() (version uint, err error)

	Prev(version uint) (prevVersion uint, err error)

	Next(version uint) (nextVersion uint, err error)

	ReadUp(version uint) (r io.ReadCloser, identifier string, err error)

	ReadDown(version uint) (r io.ReadCloser, identifier string, err error)
}

func Open

func Open(url string) (Driver, error)

type Migration

type Migration struct {
	Version    uint
	Identifier string
	Direction  Direction
	Raw        string
}

func Parse

func Parse(raw string) (*Migration, error)

type Migrations

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

func NewMigrations

func NewMigrations() *Migrations

func (*Migrations) Append

func (i *Migrations) Append(m *Migration) (ok bool)

func (*Migrations) Down

func (i *Migrations) Down(version uint) (m *Migration, ok bool)

func (*Migrations) First

func (i *Migrations) First() (version uint, ok bool)

func (*Migrations) Next

func (i *Migrations) Next(version uint) (nextVersion uint, ok bool)

func (*Migrations) Prev

func (i *Migrations) Prev(version uint) (prevVersion uint, ok bool)

func (*Migrations) Up

func (i *Migrations) Up(version uint) (m *Migration, ok bool)