migrator

Documentation

Index

• Variables
• type Control
• type Manager
  • func (m *Manager) Add() *Migration
  • func (m *Manager) Collect() []*Migration
• type Migration
  • func (m *Migration) Down(fn func(c Control)) *Migration
  • func (m Migration) IgnoreDatabase(names ...string) Migrator
  • func (m Migration) Init() error
  • func (m Migration) MustDown()
  • func (m Migration) MustInit()
  • func (m Migration) MustNew()
  • func (m Migration) MustRun()
  • func (m Migration) MustUp()
  • func (m Migration) New() error
  • func (m Migration) Run() error
  • func (m *Migration) Up(fn func(c Control)) *Migration
• type Migrator
  • func New(dir string, databases map[string]*esquel.DB, migrations []*Migration) Migrator

Variables

var (
	ErrorInvalidDatabase = errors.New("invalid database")
	ErrorInvalidDir      = errors.New("invalid directory")
)

Types

type Control

type Control interface {
	DB(name ...string) *esquel.DB
}

type Manager

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

func (*Manager) Add

func (m *Manager) Add() *Migration

func (*Manager) Collect

func (m *Manager) Collect() []*Migration

type Migration

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

func (*Migration) Down

func (m *Migration) Down(fn func(c Control)) *Migration

func (Migration) IgnoreDatabase

func (m Migration) IgnoreDatabase(names ...string) Migrator

func (Migration) Init

func (m Migration) Init() error

func (Migration) MustDown

func (m Migration) MustDown()

func (Migration) MustInit

func (m Migration) MustInit()

func (Migration) MustNew

func (m Migration) MustNew()

func (Migration) MustRun

func (m Migration) MustRun()

func (Migration) MustUp

func (m Migration) MustUp()

func (Migration) New

func (m Migration) New() error

func (Migration) Run

func (m Migration) Run() error

func (*Migration) Up

func (m *Migration) Up(fn func(c Control)) *Migration

type Migrator

type Migrator interface {
	IgnoreDatabase(names ...string) Migrator
	Run() error
	Init() error
	New() error
	Up() error
	Down() error

	MustRun()
	MustInit()
	MustNew()
	MustUp()
	MustDown()
}

func New

func New(dir string, databases map[string]*esquel.DB, migrations []*Migration) Migrator