migration

Documentation

Index

• Constants
• Variables
• func Migrate(migrations []Migration) (err error)
• type Migration
  • func All() []Migration
• type Version

Constants

const VersionKey = ".migration.version"

VersionKey is the setting containing the migration version.

Variables

var MinimumVersion = 1

MinimumVersion is the index of the earliest version that we can migrate from.

var Settings = &settings.Settings

Functions

func Migrate

func Migrate(migrations []Migration) (err error)

Migrate the hub by applying all necessary Migrations.

Types

type Migration

type Migration interface {
	Apply(*gorm.DB) error
	Models() []any
}

Migration encapsulates the functionality necessary to perform a migration.

func All

func All() []Migration

All migrations in order.

type Version

type Version struct {
	Version int `json:"version"`
}

Version represents the value of the .migration.version setting.