migorm

Documentation

Index

• Constants
• func RegisterMigration(migration any)
• func Run(ctx context.Context, migrater Migrater)
• func WithCustomMigrationsTableName(customTableName string) func(tx *gorm.DB) *gorm.DB
• type Config
• type Context
• type Logger
  • func NewLogger() Logger
• type Migrater
  • func NewMigrater(db *gorm.DB, cfg *Config) Migrater
• type NewMigration

Constants

const (
	InfoLevel  = "INFO"
	ErrorLevel = "ERROR"
)

const DefaultMigrationsTableName = "migrations"

Functions

func RegisterMigration

func RegisterMigration(migration any)

RegisterMigration Each migration file call this method in its init method

func Run

func Run(ctx context.Context, migrater Migrater)

func WithCustomMigrationsTableName

func WithCustomMigrationsTableName(customTableName string) func(tx *gorm.DB) *gorm.DB

Types

type Config

type Config struct {
	Log           Logger
	MigrationsDir string
	TableName     string
}

type Context

type Context interface {
	context.Context
	DB() *gorm.DB
	Log() Logger
}

type Logger

type Logger interface {
	Infof(template string, args ...interface{})
	Errorf(template string, args ...interface{})
}

func NewLogger

func NewLogger() Logger

type Migrater

type Migrater interface {
	Logger(ctx context.Context) Logger
	UpMigrations(ctx context.Context) error
	UpConcreteMigration(ctx context.Context, name string) error
	DownConcreteMigration(ctx context.Context, name string) error
	MakeFileMigration(ctx context.Context, name string) error
}

func NewMigrater

func NewMigrater(db *gorm.DB, cfg *Config) Migrater

type NewMigration

type NewMigration interface {
	Up(ctx Context) error
	Down(ctx Context) error
}