migrations

Documentation

Index

• Variables
• func Migrate(db *sqlx.DB, migrations []Migrator) error
• type Migration
  • func (m *Migration) MLevel() int
  • func (m *Migration) MName() string
  • func (m *Migration) MSchema() string
• type Migrator
• type Schema
  • func CurrentVersion(db *sqlx.DB) (Schema, error)

Variables

var BookmarkerMigrations = []Migrator{
	&Migration{
		Name:   "initial schema",
		Level:  1,
		Schema: v1,
	},
	&Migration{
		Name:   "add metadata",
		Level:  2,
		Schema: v2,
	},
	&Migration{
		Name:   "add archived column to bookmark",
		Level:  3,
		Schema: v3,
	},
	&Migration{
		Name:   "add full-text-search capability",
		Level:  4,
		Schema: v4,
	},
	&Migration{
		Name:   "fix metadata primary key",
		Level:  5,
		Schema: v5,
	},
}

Functions

func Migrate

func Migrate(db *sqlx.DB, migrations []Migrator) error

Migrate runs given migrations

Types

type Migration

type Migration struct {
	Name   string
	Level  int
	Schema string
}

Migration implements migrator

func (*Migration) MLevel

func (m *Migration) MLevel() int

func (*Migration) MName

func (m *Migration) MName() string

func (*Migration) MSchema

func (m *Migration) MSchema() string

type Migrator

type Migrator interface {
	// Get migration name
	MName() string
	// Get migration level
	MLevel() int
	// Get valid sql string to execute
	MSchema() string
}

Migrator describes single migration level

type Schema

type Schema struct {
	Level     int       `db:"level"`
	Success   int       `db:"success"`
	Timestamp time.Time `db:"timestamp"`
	TookMs    int       `db:"took_ms"`
}

func CurrentVersion

func CurrentVersion(db *sqlx.DB) (Schema, error)

CurrentVersion returns current version