target

Documentation

Index

• Constants
• Variables
• func ContextWithDB(ctx context.Context, db DB) context.Context
• type DB
• type DBExecer
  • func DBFromContext(ctx context.Context) (DBExecer, error)
• type Driver
• type Option
  • func Table(tableName string) Option
• type Target
  • func NewTarget(source migrations.Source, db DB, driver Driver, options ...Option) (*Target, error)
  • func (target *Target) Add(migration migrations.Migration) error
  • func (target *Target) Create() error
  • func (target *Target) Current() (migrations.Migration, error)
  • func (target *Target) Destroy() error
  • func (target *Target) Done() ([]migrations.Migration, error)
  • func (target *Target) Remove(migration migrations.Migration) error

Constants

const DefaultMigrationsTableName = "_migrations"

Variables

var (
	ErrDBInstanceNotFound = errors.New("db instance not found on the context")
	ErrInvalidDBInstance  = errors.New("context has an invalid db instance")
)

var (
	ErrMissingSource = errors.New("source is required")
)

Functions

func ContextWithDB

func ContextWithDB(ctx context.Context, db DB) context.Context

ContextWithDB returns a context with the given db attached.

Types

type DB

type DB interface {
	DBExecer
	Begin() (*sql.Tx, error)
	Query(query string, args ...interface{}) (*sql.Rows, error)
}

type DBExecer

type DBExecer interface {
	Exec(query string, args ...interface{}) (sql.Result, error)
}

func DBFromContext

func DBFromContext(ctx context.Context) (DBExecer, error)

type Driver

type Driver interface {
	migrations.TargetLocker
	Add(migration migrations.Migration) error
	Remove(migration migrations.Migration) error
}

type Option

type Option func(target *Target) error

func Table

func Table(tableName string) Option

type Target

type Target struct {
	// contains filtered or unexported fields
}

func NewTarget

func NewTarget(source migrations.Source, db DB, driver Driver, options ...Option) (*Target, error)

func (*Target) Add

func (target *Target) Add(migration migrations.Migration) error

func (*Target) Create

func (target *Target) Create() error

func (*Target) Current

func (target *Target) Current() (migrations.Migration, error)

func (*Target) Destroy

func (target *Target) Destroy() error

func (*Target) Done

func (target *Target) Done() ([]migrations.Migration, error)

func (*Target) Remove

func (target *Target) Remove(migration migrations.Migration) error