basemigrate

Documentation

Index

• Variables
• func Migrate(filename string, prefix string, max int, verbose bool) error
• func Reset(filename string, prefix string, max int, verbose bool) (err error)
• type Changeset
  • func (cs *Changeset) AddChange(line string)
  • func (cs *Changeset) AddRollback(line string)
  • func (cs *Changeset) Changes() string
  • func (cs *Changeset) Checksum() string
  • func (cs *Changeset) ParseHeader(line string) error
  • func (cs *Changeset) Rollbacks() string
  • func (cs *Changeset) SetFileInfo(filename string, description string, version string)
• type DBChangeset

Variables

var (
	// ErrInvalidHeader is when the changeset header is invalid.
	ErrInvalidHeader = errors.New("invalid changeset header")
	// ErrInvalidFormat is when a changeset is not found.
	ErrInvalidFormat = errors.New("invalid changeset format")
)

Functions

func Migrate

func Migrate(filename string, prefix string, max int, verbose bool) error

Migrate will perform all the migrations in a file. If max is 0, all migrations are run.

func Reset

func Reset(filename string, prefix string, max int, verbose bool) (err error)

Reset will remove all migrations. If max is 0, all rollbacks are run.

Types

type Changeset

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

Changeset is a SQL changeset.

func (*Changeset) AddChange

func (cs *Changeset) AddChange(line string)

AddChange will add a change command.

func (*Changeset) AddRollback

func (cs *Changeset) AddRollback(line string)

AddRollback will add a rollback command.

func (*Changeset) Changes

func (cs *Changeset) Changes() string

Changes will return all the changes.

func (*Changeset) Checksum

func (cs *Changeset) Checksum() string

Checksum returns an MD5 checksum for the changeset.

func (*Changeset) ParseHeader

func (cs *Changeset) ParseHeader(line string) error

ParseHeader will parse the header information.

func (*Changeset) Rollbacks

func (cs *Changeset) Rollbacks() string

Rollbacks will return all the rollbacks.

func (*Changeset) SetFileInfo

func (cs *Changeset) SetFileInfo(filename string, description string, version string)

SetFileInfo will set the file information.

type DBChangeset

type DBChangeset struct {
	ID            string `db:"id"`
	Author        string `db:"author"`
	Filename      string `db:"filename"`
	OrderExecuted int    `db:"orderexecuted"`
}

DBChangeset represents the database table records.