migrations

Documentation

Index

• func EnsureUpToDate(x *xorm.Engine) error
• func ExpectedVersion() int64
• func GetCurrentDBVersion(x *xorm.Engine) (int64, error)
• func Migrate(x *xorm.Engine) error
• type Migration
  • func NewMigration(desc string, fn func(*xorm.Engine) error) Migration
• type Version

Functions

func EnsureUpToDate

func EnsureUpToDate(x *xorm.Engine) error

EnsureUpToDate will check if the db is at the correct version

func ExpectedVersion

func ExpectedVersion() int64

ExpectedVersion returns the expected db version

func GetCurrentDBVersion

func GetCurrentDBVersion(x *xorm.Engine) (int64, error)

GetCurrentDBVersion returns the current db version

func Migrate

func Migrate(x *xorm.Engine) error

Migrate database to current version

Types

type Migration

type Migration interface {
	Description() string
	Migrate(*xorm.Engine) error
}

Migration describes on migration from lower version to high version

func NewMigration

func NewMigration(desc string, fn func(*xorm.Engine) error) Migration

NewMigration creates a new migration

type Version

type Version struct {
	ID      int64 `xorm:"pk autoincr"`
	Version int64
}

Version describes the version table. Should have only one row with id==1