migrate

Documentation

Overview

Package migrate applies ordered SQL migrations and records checksums.

Package migrate provides a small production-oriented SQL migration runner.

Index

• type Dialect
• type Migration
  • func FromFS(files fs.FS, root string) ([]Migration, error)
• type Runner
  • func (r Runner) Up(ctx context.Context, migrations []Migration) error

Types

type Dialect

type Dialect string

const (
	DialectPostgres Dialect = "postgres"
	DialectMySQL    Dialect = "mysql"
	DialectSQLite   Dialect = "sqlite"
)

type Migration

type Migration struct {
	Version  string
	Name     string
	SQL      string
	Checksum string
}

func FromFS

func FromFS(files fs.FS, root string) ([]Migration, error)

type Runner

type Runner struct {
	DB      *sql.DB
	Dialect Dialect
	Table   string
	Now     func() time.Time
}

func (Runner) Up

func (r Runner) Up(ctx context.Context, migrations []Migration) error