dbmate

Documentation

Index

• Constants
• Variables
• func RegisterDriver(f DriverFunc, scheme string)
• type DB
  • func New(databaseURL *url.URL) *DB
  • func (db *DB) CheckMigrationsStatus(drv Driver) ([]StatusResult, error)
  • func (db *DB) Create() error
  • func (db *DB) CreateAndMigrate() error
  • func (db *DB) Drop() error
  • func (db *DB) DumpSchema() error
  • func (db *DB) GetDriver() (Driver, error)
  • func (db *DB) Migrate() error
  • func (db *DB) NewMigration(name string) error
  • func (db *DB) Rollback() error
  • func (db *DB) Status(quiet bool) (int, error)
  • func (db *DB) Wait() error
• type Driver
• type DriverConfig
• type DriverFunc
• type Migration
  • func NewMigration() Migration
• type MigrationOptions
• type StatusResult

Constants

const DefaultMigrationsDir = "./db/migrations"

DefaultMigrationsDir specifies default directory to find migration files

const DefaultMigrationsTableName = "schema_migrations"

DefaultMigrationsTableName specifies default database tables to record migraitons in

const DefaultSchemaFile = "./db/schema.sql"

DefaultSchemaFile specifies default location for schema.sql

const DefaultWaitInterval = time.Second

DefaultWaitInterval specifies length of time between connection attempts

const DefaultWaitTimeout = 60 * time.Second

DefaultWaitTimeout specifies maximum time for connection attempts

const Version = "1.16.2"

Version of dbmate

Variables

var (
	ErrNoMigrationFiles      = errors.New("no migration files found")
	ErrInvalidURL            = errors.New("invalid url, have you set your --url flag or DATABASE_URL environment variable?")
	ErrNoRollback            = errors.New("can't rollback: no migrations have been applied")
	ErrCantConnect           = errors.New("unable to connect to database")
	ErrUnsupportedDriver     = errors.New("unsupported driver")
	ErrNoMigrationName       = errors.New("please specify a name for the new migration")
	ErrMigrationAlreadyExist = errors.New("file already exists")
	ErrMigrationDirNotFound  = errors.New("could not find migrations directory")
	ErrMigrationNotFound     = errors.New("can't find migration file")
	ErrCreateDirectory       = errors.New("unable to create directory")
)

Error codes

var (
	ErrParseMissingUp      = errors.New("dbmate requires each migration to define an up block with '-- migrate:up'")
	ErrParseUnexpectedStmt = errors.New("dbmate does not support statements defined outside of the '-- migrate:up' or '-- migrate:down' blocks")
)

Error codes

Functions

func RegisterDriver

func RegisterDriver(f DriverFunc, scheme string)

RegisterDriver registers a driver constructor for a given URL scheme

Types

type DB

type DB struct {
	AutoDumpSchema      bool
	DatabaseURL         *url.URL
	MigrationsDir       string
	MigrationsTableName string
	SchemaFile          string
	Verbose             bool
	WaitBefore          bool
	WaitInterval        time.Duration
	WaitTimeout         time.Duration
	Log                 io.Writer
}

DB allows dbmate actions to be performed on a specified database

func New

func New(databaseURL *url.URL) *DB

New initializes a new dbmate database

func (*DB) CheckMigrationsStatus

func (db *DB) CheckMigrationsStatus(drv Driver) ([]StatusResult, error)

CheckMigrationsStatus returns the status of all available mgirations

func (*DB) Create

func (db *DB) Create() error

Create creates the current database

func (*DB) CreateAndMigrate

func (db *DB) CreateAndMigrate() error

CreateAndMigrate creates the database (if necessary) and runs migrations

func (*DB) Drop

func (db *DB) Drop() error

Drop drops the current database (if it exists)

func (*DB) DumpSchema

func (db *DB) DumpSchema() error

DumpSchema writes the current database schema to a file

func (*DB) GetDriver

func (db *DB) GetDriver() (Driver, error)

GetDriver initializes the appropriate database driver

func (*DB) Migrate

func (db *DB) Migrate() error

Migrate migrates database to the latest version

func (*DB) NewMigration

func (db *DB) NewMigration(name string) error

NewMigration creates a new migration file

func (*DB) Rollback

func (db *DB) Rollback() error

Rollback rolls back the most recent migration

func (*DB) Status

func (db *DB) Status(quiet bool) (int, error)

Status shows the status of all migrations

func (*DB) Wait

func (db *DB) Wait() error

Wait blocks until the database server is available. It does not verify that the specified database exists, only that the host is ready to accept connections.

type Driver

type Driver interface {
	Open() (*sql.DB, error)
	DatabaseExists() (bool, error)
	CreateDatabase() error
	DropDatabase() error
	DumpSchema(*sql.DB) ([]byte, error)
	MigrationsTableExists(*sql.DB) (bool, error)
	CreateMigrationsTable(*sql.DB) error
	SelectMigrations(*sql.DB, int) (map[string]bool, error)
	InsertMigration(dbutil.Transaction, string) error
	DeleteMigration(dbutil.Transaction, string) error
	Ping() error
}

Driver provides top level database functions

type DriverConfig

type DriverConfig struct {
	DatabaseURL         *url.URL
	MigrationsTableName string
	Log                 io.Writer
}

DriverConfig holds configuration passed to driver constructors

type DriverFunc

type DriverFunc func(DriverConfig) Driver

DriverFunc represents a driver constructor

type Migration

type Migration struct {
	Contents string
	Options  MigrationOptions
}

Migration contains the migration contents and options

func NewMigration

func NewMigration() Migration

NewMigration constructs a Migration object

type MigrationOptions

type MigrationOptions interface {
	Transaction() bool
}

MigrationOptions is an interface for accessing migration options

type StatusResult

type StatusResult struct {
	Filename string
	Applied  bool
}

StatusResult represents an available migration status