migration

Documentation

Index

• func RegisterMigration(migration *Migration)
• func ResetMigrations()
• func ValidateRegistry() error
• type Migration
  • func GetRegisteredMigrations() []*Migration
• type MigrationRecord
• type Migrator
  • func NewMigrator(db *gorm.DB) *Migrator
  • func (m *Migrator) Down() error
  • func (m *Migrator) GetAppliedVersions() (map[string]bool, error)
  • func (m *Migrator) Register(migration *Migration)
  • func (m *Migrator) Up() error
• type ModelRegistry

Functions

func RegisterMigration

func RegisterMigration(migration *Migration)

func ResetMigrations

func ResetMigrations()

func ValidateRegistry

func ValidateRegistry() error

Validate that registry is provided

Types

type Migration

type Migration struct {
	Version   string
	Name      string
	CreatedAt time.Time
	Up        func(*gorm.DB) error
	Down      func(*gorm.DB) error
}

func GetRegisteredMigrations

func GetRegisteredMigrations() []*Migration

type MigrationRecord

type MigrationRecord struct {
	Version   string    `gorm:"primaryKey"`
	Name      string    `gorm:"not null"`
	AppliedAt time.Time `gorm:"not null"`
}

type Migrator

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

func NewMigrator

func NewMigrator(db *gorm.DB) *Migrator

func (*Migrator) Down

func (m *Migrator) Down() error

func (*Migrator) GetAppliedVersions

func (m *Migrator) GetAppliedVersions() (map[string]bool, error)

func (*Migrator) Register

func (m *Migrator) Register(migration *Migration)

func (*Migrator) Up

func (m *Migrator) Up() error

type ModelRegistry

type ModelRegistry interface {
	GetModels() map[string]interface{}
}

ModelRegistry - users must implement this

var GlobalModelRegistry ModelRegistry

Global registry - users set this in their main.go