migrations

Documentation

Index

• func RunMigrations(fs afero.Fs, configFile string, forceApply bool) error
• type Migration

Functions

func RunMigrations

func RunMigrations(fs afero.Fs, configFile string, forceApply bool) error

RunMigrations cycles through a list of migrations and applies them if necessary

Types

type Migration

type Migration interface {
	Description() string                      //Describes the migration taking
	Guard(afero.Fs, string) (bool, error)     //Returns true if migration is runnable, otherwise error
	Migrate(afero.Fs, string) (string, error) //Returns path to config and err
	Prompt() bool                             //Returns whether the user would like to run the migration
}

Migration Defines a fogg migration and the actions that it can perform