migrate

Documentation

Index

• Variables
• func Register(Factory Factory)
• type Factory
• type Migrate
• type Migration

Variables

var Migrations []Migration

Migrations represents a sets of migrations

Functions

func Register

func Register(Factory Factory)

Register registers a new factory for a migration

Types

type Factory

type Factory func(ctx xcontext.Context) Migrate

Factory defines a factory type of an object implementing Migration interface

type Migrate

type Migrate interface {
	Up(tx *sql.Tx) error
	Down(tx *sql.Tx) error
	UpNoTx(db *sql.DB) error
	DownNoTx(db *sql.DB) error
}

Migrate is the interface that every migration task must implement to support

type Migration

type Migration struct {
	Factory Factory
	Name    string
}

Migration represents a migration task registered in the migration tool