migration

README

flam-database-migration

flam-database-migration is a flam-in-go extension to provide database migrations functionalities

Documentation

Index

• Constants
• Variables
• func NewProvider() flam.Provider
• type Facade
• type Info
• type Logger
• type LoggerCreator
• type Migration
• type Migrator
• type MigratorCreator

Constants

const (
	LoggerCreatorGroup    = "flam.database_migration.loggers.creator"
	LoggerDriverDefault   = "flam.database_migration.loggers.driver.default"
	MigratorCreatorGroup  = "flam.database_migration.migrators.creator"
	MigratorDriverDefault = "flam.database_migration.migrators.driver.default"
	MigrationGroup        = "flam.database_migration.migrations"

	PathDefaultConnection    = "flam.database_migration.defaults.connection"
	PathDefaultLogger        = "flam.database_migration.defaults.logger"
	PathDefaultLogChannel    = "flam.database_migration.defaults.log.channel"
	PathDefaultLogStartLevel = "flam.database_migration.defaults.log.start.level"
	PathDefaultLogErrorLevel = "flam.database_migration.defaults.log.error.level"
	PathDefaultLogDoneLevel  = "flam.database_migration.defaults.log.done.level"
	PathBoot                 = "flam.database_migration.boot"
	PathLoggers              = "flam.database_migration.loggers"
	PathMigrators            = "flam.database_migration.migrators"
)

Variables

var (
	DefaultConnection    = ""
	DefaultLogger        = ""
	DefaultLogChannel    = "flam"
	DefaultLogStartLevel = log.Info
	DefaultLogErrorLevel = log.Error
	DefaultLogDoneLevel  = log.Info
)

var (
	ErrMigrationNotFound = errors.New("migration not found")
)

Functions

func NewProvider

func NewProvider() flam.Provider

Types

type Facade

type Facade interface {
	HasLogger(id string) bool
	ListLoggers() []string
	GetLogger(id string) (Logger, error)
	AddLogger(id string, logger Logger) error

	HasMigrator(id string) bool
	ListMigrators() []string
	GetMigrator(id string) (Migrator, error)
	AddMigrator(id string, migrator Migrator) error
}

type Info

type Info struct {
	Version     string
	Description string
	InstalledAt *time.Time
}

type Logger

type Logger interface {
	LogUpStart(migration Info) error
	LogUpError(migration Info, e error) error
	LogUpDone(migration Info) error

	LogDownStart(migration Info) error
	LogDownError(migration Info, e error) error
	LogDownDone(migration Info) error
}

type LoggerCreator

type LoggerCreator interface {
	Accept(config flam.Bag) bool
	Create(config flam.Bag) (Logger, error)
}

type Migration

type Migration interface {
	Group() string
	Version() string
	Description() string
	Up(connection database.Connection) error
	Down(connection database.Connection) error
}

type Migrator

type Migrator interface {
	List() ([]Info, error)
	Current() (*Info, error)
	CanUp() bool
	CanDown() bool
	Up() error
	UpAll() error
	Down() error
	DownAll() error
}

type MigratorCreator

type MigratorCreator interface {
	Accept(config flam.Bag) bool
	Create(config flam.Bag) (Migrator, error)
}