gossage

README

gossage

cockroachdb database migration library

Documentation

Index

• Variables
• type ByVersion
  • func (v ByVersion) Len() int
  • func (v ByVersion) Less(i, j int) bool
  • func (v ByVersion) Swap(i, j int)
• type Gossage
  • func New(db *sql.DB) (*Gossage, error)
  • func (g *Gossage) DownTo(version string) error
  • func (g *Gossage) RegisterMigrations(migrations ...Migration) error
  • func (g *Gossage) Up() error
• type Migration
• type MigrationHistory
  • func NewMigrationHistory(db *sql.DB) *MigrationHistory
  • func (mh *MigrationHistory) AddMigration(m Migration) error
  • func (mh *MigrationHistory) Initialize() error
  • func (mh *MigrationHistory) LatestVersion() (Version, error)
  • func (mh *MigrationHistory) RevertMigration(version string) error
  • func (mh *MigrationHistory) VersionsGreaterThan(version string) ([]string, error)
• type Version

Variables

var Logger func(format string, a ...interface{})

Types

type ByVersion

type ByVersion []Migration

func (ByVersion) Len

func (v ByVersion) Len() int

func (ByVersion) Less

func (v ByVersion) Less(i, j int) bool

func (ByVersion) Swap

func (v ByVersion) Swap(i, j int)

type Gossage

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

func New

func New(db *sql.DB) (*Gossage, error)

func (*Gossage) DownTo

func (g *Gossage) DownTo(version string) error

func (*Gossage) RegisterMigrations

func (g *Gossage) RegisterMigrations(migrations ...Migration) error

func (*Gossage) Up

func (g *Gossage) Up() error

type Migration

type Migration interface {
	Version() string
	Up(*sql.Tx) error
	Down(*sql.Tx) error
}

type MigrationHistory

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

func NewMigrationHistory

func NewMigrationHistory(db *sql.DB) *MigrationHistory

func (*MigrationHistory) AddMigration

func (mh *MigrationHistory) AddMigration(m Migration) error

func (*MigrationHistory) Initialize

func (mh *MigrationHistory) Initialize() error

func (*MigrationHistory) LatestVersion

func (mh *MigrationHistory) LatestVersion() (Version, error)

func (*MigrationHistory) RevertMigration

func (mh *MigrationHistory) RevertMigration(version string) error

func (*MigrationHistory) VersionsGreaterThan

func (mh *MigrationHistory) VersionsGreaterThan(version string) ([]string, error)

type Version

type Version struct {
	Id      string
	Version string
	Applied bool
	Created time.Time
	Updated time.Time
}