migrations

Documentation

Index

• func ExpectedVersion() int64
• func GetCurrentDBVersion(engine *xorm.Engine) (int64, error)
• func InitDB(dataConf *data.Database) (err error)
• func Migrate(dbConf *data.Database, cacheConf *data.CacheConf) error
• func UpdateInstallInfo(dataConf *data.Database, language string, siteName string, siteURL string, ...) error
• type Migration
  • func NewMigration(desc string, fn func(*xorm.Engine) error, shouldCleanCache bool) Migration

Functions

func ExpectedVersion

func ExpectedVersion() int64

ExpectedVersion returns the expected db version

func GetCurrentDBVersion

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

GetCurrentDBVersion returns the current db version

func InitDB

func InitDB(dataConf *data.Database) (err error)

InitDB init db

func Migrate

func Migrate(dbConf *data.Database, cacheConf *data.CacheConf) error

Migrate database to current version

func UpdateInstallInfo

func UpdateInstallInfo(dataConf *data.Database, language string,
	siteName string,
	siteURL string,
	contactEmail string,
	adminName string,
	adminPassword string,
	adminEmail string) error

UpdateInstallInfo update some init data about the admin interface and admin password

Types

type Migration

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

Migration describes on migration from lower version to high version

func NewMigration

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

NewMigration creates a new migration