mysql

Documentation

Index

• func NewDriver(config dbmate.DriverConfig) dbmate.Driver
• type Driver
  • func (drv *Driver) CreateDatabase() error
  • func (drv *Driver) CreateMigrationsTable(db *sql.DB) error
  • func (drv *Driver) DatabaseExists() (bool, error)
  • func (drv *Driver) DeleteMigration(db dbutil.Transaction, version string) error
  • func (drv *Driver) DropDatabase() error
  • func (drv *Driver) DumpSchema(db *sql.DB) ([]byte, error)
  • func (drv *Driver) InsertMigration(db dbutil.Transaction, version string) error
  • func (drv *Driver) MigrationsTableExists(db *sql.DB) (bool, error)
  • func (drv *Driver) Open() (*sql.DB, error)
  • func (drv *Driver) Ping() error
  • func (drv *Driver) QueryError(query string, err error) error
  • func (drv *Driver) SelectMigrations(db *sql.DB, limit int) (map[string]bool, error)

Functions

func NewDriver

func NewDriver(config dbmate.DriverConfig) dbmate.Driver

NewDriver initializes the driver

Types

type Driver

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

Driver provides top level database functions

func (*Driver) CreateDatabase

func (drv *Driver) CreateDatabase() error

CreateDatabase creates the specified database

func (*Driver) CreateMigrationsTable

func (drv *Driver) CreateMigrationsTable(db *sql.DB) error

CreateMigrationsTable creates the schema_migrations table

func (*Driver) DatabaseExists

func (drv *Driver) DatabaseExists() (bool, error)

DatabaseExists determines whether the database exists

func (*Driver) DeleteMigration

func (drv *Driver) DeleteMigration(db dbutil.Transaction, version string) error

DeleteMigration removes a migration record

func (*Driver) DropDatabase

func (drv *Driver) DropDatabase() error

DropDatabase drops the specified database (if it exists)

func (*Driver) DumpSchema

func (drv *Driver) DumpSchema(db *sql.DB) ([]byte, error)

DumpSchema returns the current database schema

func (*Driver) InsertMigration

func (drv *Driver) InsertMigration(db dbutil.Transaction, version string) error

InsertMigration adds a new migration record

func (*Driver) MigrationsTableExists

func (drv *Driver) MigrationsTableExists(db *sql.DB) (bool, error)

MigrationsTableExists checks if the schema_migrations table exists

func (*Driver) Open

func (drv *Driver) Open() (*sql.DB, error)

Open creates a new database connection

func (*Driver) Ping

func (drv *Driver) Ping() error

Ping verifies a connection to the database server. It does not verify whether the specified database exists.

func (*Driver) QueryError

func (drv *Driver) QueryError(query string, err error) error

Return a normalized version of the driver-specific error type.

func (*Driver) SelectMigrations

func (drv *Driver) SelectMigrations(db *sql.DB, limit int) (map[string]bool, error)

SelectMigrations returns a list of applied migrations with an optional limit (in descending order)