fizzx

Documentation

Index

• func CreateSchemaMigrations(c *pop.Connection) error
• func MigrationContent(mf Migration, c *pop.Connection, r io.Reader, usingTemplate bool) ([]string, error)
• type DumpMigrator
  • func NewDumpMigrator(path string, dest string, shouldReplace, dumpSchema bool, c *pop.Connection, ...) (DumpMigrator, error)
• type Migration
  • func (mf Migration) Run() ([]MigrationTuple, error)
• type MigrationTuple
• type Migrations
  • func (mfs *Migrations) Filter(f func(mf Migration) bool)
  • func (mfs Migrations) Len() int
  • func (mfs Migrations) Less(i, j int) bool
  • func (mfs Migrations) Swap(i, j int)
• type Migrator
  • func NewMigrator(c *pop.Connection, l *logrusx.Logger) Migrator
  • func (m Migrator) CreateSchemaMigrations() error
  • func (m Migrator) Down(step int) error
  • func (m Migrator) DumpMigrationSchema() error
  • func (m Migrator) Reset() error
  • func (m Migrator) Status(out io.Writer) error
  • func (m Migrator) Up() error
  • func (m Migrator) UpTo(step int) (applied int, err error)

Functions

func CreateSchemaMigrations

func CreateSchemaMigrations(c *pop.Connection) error

CreateSchemaMigrations sets up a table to track migrations. This is an idempotent operation.

func MigrationContent

func MigrationContent(mf Migration, c *pop.Connection, r io.Reader, usingTemplate bool) ([]string, error)

Types

type DumpMigrator

type DumpMigrator struct {
	Migrator
	Path string
}

func NewDumpMigrator

func NewDumpMigrator(path string, dest string, shouldReplace, dumpSchema bool, c *pop.Connection, l *logrusx.Logger) (DumpMigrator, error)

type Migration

type Migration struct {
	// Path to the migration (./migrations/123_create_widgets.up.sql)
	Path string
	// Version of the migration (123)
	Version string
	// Name of the migration (create_widgets)
	Name string
	// Direction of the migration (up)
	Direction string
	// Type of migration (sql)
	Type string
	// DB type (all|postgres|mysql...)
	DBType string
	// Runner function to run/execute the migration
	Runner func(mf Migration) ([]MigrationTuple, error)
}

Migration handles the data for a given database migration

func (Migration) Run

func (mf Migration) Run() ([]MigrationTuple, error)

Run the migration. Returns an error if there is no mf.Runner defined.

type MigrationTuple

type MigrationTuple struct {
	ID        string
	Statement string
}

type Migrations

type Migrations []Migration

Migrations is a collection of Migration

func (*Migrations) Filter

func (mfs *Migrations) Filter(f func(mf Migration) bool)

func (Migrations) Len

func (mfs Migrations) Len() int

func (Migrations) Less

func (mfs Migrations) Less(i, j int) bool

func (Migrations) Swap

func (mfs Migrations) Swap(i, j int)

type Migrator

type Migrator struct {
	Connection *pop.Connection
	SchemaPath string
	Migrations map[string]Migrations
	// contains filtered or unexported fields
}

Migrator forms the basis of all migrations systems. It does the actual heavy lifting of running migrations. When building a new migration system, you should embed this type into your migrator.

func NewMigrator

func NewMigrator(c *pop.Connection, l *logrusx.Logger) Migrator

NewMigrator returns a new "blank" migrator. It is recommended to use something like MigrationBox or FileMigrator. A "blank" Migrator should only be used as the basis for a new type of migration system.

func (Migrator) CreateSchemaMigrations

func (m Migrator) CreateSchemaMigrations() error

CreateSchemaMigrations sets up a table to track migrations. This is an idempotent operation.

func (Migrator) Down

func (m Migrator) Down(step int) error

Down runs pending "down" migrations and rolls back the database by the specified number of steps.

func (Migrator) DumpMigrationSchema

func (m Migrator) DumpMigrationSchema() error

DumpMigrationSchema will generate a file of the current database schema based on the value of Migrator.SchemaPath

func (Migrator) Reset

func (m Migrator) Reset() error

Reset the database by running the down migrations followed by the up migrations.

func (Migrator) Status

func (m Migrator) Status(out io.Writer) error

Status prints out the status of applied/pending migrations.

func (Migrator) Up

func (m Migrator) Up() error

Up runs pending "up" migrations and applies them to the database.

func (Migrator) UpTo

func (m Migrator) UpTo(step int) (applied int, err error)

UpTo runs up to step "up" migrations and applies them to the database. If step <= 0 all pending migrations are run.