migrator

package

v0.1.2 Latest Latest Go to latest Published: Feb 26, 2020 License: MIT Imports: 3 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Migration struct {
	Name string
	Func func(*sql.Tx) error
}

Migration represents a single migration

func (m *Migration) String() string

String returns a string representation of the migration

type MigrationNoTx struct {
	Name string
	Func func(*sql.DB) error
}

MigrationNoTx represents a single not transactional migration

func (m *MigrationNoTx) String() string

type Migrator struct {
	TableName string
	// contains filtered or unexported fields
}

Migrator is the migrator implementation

func New(opts ...Option) (*Migrator, error)

New creates a new migrator instance

func (m *Migrator) Migrate(db *sql.DB) error

Migrate applies all available migrations

func (m *Migrator) NeedUpgrade(db *sql.DB) (bool, error)

NeedUpgrade returns True if database need to be updated with migrations

func (m *Migrator) Pending(db *sql.DB) ([]interface{}, error)

Pending returns all pending (not yet applied) migrations

type Option func(*Migrator)

Option sets options such migrations or table name.

func Migrations(migrations ...interface{}) Option

Migrations creates an option with provided migrations

func SetNotice(noticeFunc func(string)) Option

SetNotice overrides the default standard output function

func TableName(tableName string) Option

TableName creates an option to allow overriding the default table name