gorm_migration

README

GORM-based migration workaround

1. Write migration functions with Golang
2. Register functions on MigrationManger
3. Execute the migrate or rollback command

WHY

If you've used rails, you'll be impressed by its migration management.

gorm-migration is a clumsy parody, I've implemented basic migration management, including Check, Migrate and Rollback.

Install

go get github.com/icbd/gorm-migration

How to use

For some types of databases, you need to create the database first.

Migrate

It will perform all the tasks that haven't been run yet.

db := newMemoryDB()
mm := NewMigrationManger(db, Migrate)
mm.RegisterFunctions(
    mm.createUsersTable,
    mm.addAvatarToUsers,
    mm.addEmailIndexToUsers)
mm.Migrate()

Rollback

It will roll it back step by step.

# ...
mm.Type = Rollback
mm.Migrate()

Check

# ...
mm.Type = Check
mm.Migrate()

License

MIT, see LICENSE

Documentation

Index

• type MigrateType
  • func (t *MigrateType) Set(value string) error
  • func (t *MigrateType) String() string
• type MigrationManger
  • func NewMigrationManger(db *gorm.DB, t MigrateType) *MigrationManger
  • func (mm *MigrationManger) Change(up, down changeFunc) error
  • func (mm *MigrationManger) ChangeColumn(dst interface{}, column string) error
  • func (mm *MigrationManger) ChangeFuncWrap(sqlLines ...string) changeFunc
  • func (mm *MigrationManger) ChangeTable(dst interface{}) error
  • func (mm *MigrationManger) IsCompleted() bool
  • func (mm *MigrationManger) Migrate()
  • func (mm *MigrationManger) RegisterFunctions(changeFunctions ...changeFunc) *MigrationManger
• type SchemaMigration

Types

type MigrateType

type MigrateType int8

const (
	Check MigrateType = iota
	Migrate
	Rollback
)

func (*MigrateType) Set

func (t *MigrateType) Set(value string) error

Set for flag parse implement: type Value interface

func (*MigrateType) String

func (t *MigrateType) String() string

String for flag parse implement: type Value interface

type MigrationManger

type MigrationManger struct {
	DB         *gorm.DB
	Type       MigrateType
	Columns    []*SchemaMigration // saved in database
	Migrations []*SchemaMigration // registered by code
}

func NewMigrationManger

func NewMigrationManger(db *gorm.DB, t MigrateType) *MigrationManger

func (*MigrationManger) Change

func (mm *MigrationManger) Change(up, down changeFunc) error

Change migrate up or migrate down

func (*MigrationManger) ChangeColumn

func (mm *MigrationManger) ChangeColumn(dst interface{}, column string) error

ChangeColumn create or drop table

func (*MigrationManger) ChangeFuncWrap

func (mm *MigrationManger) ChangeFuncWrap(sqlLines ...string) changeFunc

func (*MigrationManger) ChangeTable

func (mm *MigrationManger) ChangeTable(dst interface{}) error

ChangeTable create or drop table

func (*MigrationManger) IsCompleted

func (mm *MigrationManger) IsCompleted() bool

IsCompleted fill mm Columns, and check Columns match with Migrations

func (*MigrationManger) Migrate

func (mm *MigrationManger) Migrate()

Migrate trigger

func (*MigrationManger) RegisterFunctions

func (mm *MigrationManger) RegisterFunctions(changeFunctions ...changeFunc) *MigrationManger

RegisterFunctions fill it by user

type SchemaMigration

type SchemaMigration struct {
	gorm.Model
	FuncName string
	// contains filtered or unexported fields
}

save to database