Version: v3.5.4+incompatible Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Oct 10, 2018 License: MIT Imports: 13 Imported by: 0




URL Query WithInstance Config Description
x-migrations-table MigrationsTable Name of the migrations table
dbname DatabaseName The name of the database to connect to
user The user to sign in as
password The user's password
host The host to connect to.
port The port to bind to.
tls TLS / SSL encrypted connection parameter; see go-sql-driver. Use any name (e.g. migrate) if you want to use a custom TLS config (x-tls- queries).
x-tls-ca The location of the CA (certificate authority) file.
x-tls-cert The location of the client certicicate file. Must be used with x-tls-key.
x-tls-key The location of the private key file. Must be used with x-tls-cert.
x-tls-insecure-skip-verify Whether or not to use SSL (true|false)

Use with existing client

If you use the MySQL driver with existing database client, you must create the client with parameter multiStatements=true:

package main

import (
    _ ""
    _ ""

func main() {
    db, _ := sql.Open("mysql", "user:password@tcp(host:port)/dbname?multiStatements=true")
    driver, _ := mysql.WithInstance(db, &mysql.Config{})
    m, _ := migrate.NewWithDatabaseInstance(

Upgrading from v1

  1. Write down the current migration version from schema_migrations
  2. DROP TABLE schema_migrations
  3. Wrap your existing migrations in transactions (BEGIN/COMMIT) if you use multiple statements within one migration.
  4. Download and install the latest migrate version.
  5. Force the current migration version with migrate force <current_version>.




This section is empty.


View Source
var (
	ErrDatabaseDirty    = fmt.Errorf("database is dirty")
	ErrNilConfig        = fmt.Errorf("no config")
	ErrNoDatabaseName   = fmt.Errorf("no database name")
	ErrAppendPEM        = fmt.Errorf("failed to append PEM")
	ErrTLSCertKeyConfig = fmt.Errorf("To use TLS client authentication, both x-tls-cert and x-tls-key must not be empty")
View Source
var DefaultMigrationsTable = "schema_migrations"


func WithInstance

func WithInstance(instance *sql.DB, config *Config) (database.Driver, error)

instance must have `multiStatements` set to true


type Config

type Config struct {
	MigrationsTable string
	DatabaseName    string

type Mysql

type Mysql struct {
	// contains filtered or unexported fields

func (*Mysql) Close

func (m *Mysql) Close() error

func (*Mysql) Drop

func (m *Mysql) Drop() error

func (*Mysql) Lock

func (m *Mysql) Lock() error

func (*Mysql) Open

func (m *Mysql) Open(url string) (database.Driver, error)

func (*Mysql) Run

func (m *Mysql) Run(migration io.Reader) error

func (*Mysql) SetVersion

func (m *Mysql) SetVersion(version int, dirty bool) error

func (*Mysql) Unlock

func (m *Mysql) Unlock() error

func (*Mysql) Version

func (m *Mysql) Version() (version int, dirty bool, err error)

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL