migrate/migrate.go

109 lines
2.5 KiB
Go
Raw Normal View History

2016-10-21 20:01:00 +02:00
// Package migrate allows you to update your database from your application
package migrate
import (
"database/sql"
"errors"
"fmt"
"strconv"
)
// Options contains all settings
type Options struct {
TableName string // Name used for version info table; defaults to DefaultTableName if not set
2019-11-12 13:01:36 +01:00
Schema string // Schema used for version info table; In PostgreSQL the current schema is changed to the one specified here
2016-10-21 20:01:00 +02:00
AssetPrefix string
}
// DefaultTableName is the name used when no TableName is specified in Options
const DefaultTableName = `version`
// ErrUpdatesMissing indicates an update is missing, making it impossible to execute the migration
var ErrUpdatesMissing = errors.New(`Missing migration files`)
const fileFormat = `%04d.sql`
// AssetFunc is a function that returns the data for the given name
type AssetFunc func(string) ([]byte, error)
// Migrate executes migrations to get to the desired version
// Downgrading is not supported as it could result in data loss
2016-10-21 20:01:00 +02:00
func Migrate(db *sql.DB, version int, o Options, asset AssetFunc) error {
2019-11-12 13:01:36 +01:00
dbType := getDbType(db)
2016-10-21 20:01:00 +02:00
if o.TableName == `` {
o.TableName = DefaultTableName
}
var err error
searchPath := `public`
2019-11-12 13:01:36 +01:00
tx, err := db.Begin()
if err != nil {
return err
}
defer tx.Rollback()
2017-04-19 14:45:11 +02:00
2019-11-12 13:01:36 +01:00
if o.Schema != `` {
err = createSchemaIfNotExists(tx, o.Schema)
2017-04-19 14:45:11 +02:00
if err != nil {
return err
}
2019-11-12 13:01:36 +01:00
if dbType == `pq` {
_ = tx.QueryRow(`SHOW search_path`).Scan(&searchPath)
_, err = tx.Exec(`SET search_path TO ` + o.Schema)
if err != nil {
return err
}
}
2016-10-21 20:01:00 +02:00
}
2019-11-12 13:01:36 +01:00
versionTable, err := createTableIfNotExists(tx, o.Schema, o.TableName)
2016-10-21 20:01:00 +02:00
if err != nil {
return err
}
2019-11-12 13:01:36 +01:00
row := tx.QueryRow(`SELECT version FROM ` + versionTable + ` ORDER BY Version DESC`)
2016-10-21 20:01:00 +02:00
var v int
err = row.Scan(&v)
if err != sql.ErrNoRows && err != nil {
return err
}
for i := v + 1; i <= version; i++ {
2019-10-28 13:01:29 +01:00
fileName := fmt.Sprintf(o.AssetPrefix+fileFormat, i)
errorf := func(e error) error { return fmt.Errorf(`migration "%s" failed: %w`, fileName, e) }
script, err := asset(fileName)
2016-10-21 20:01:00 +02:00
if err != nil {
2019-10-28 13:01:29 +01:00
return errorf(ErrUpdatesMissing)
2016-10-21 20:01:00 +02:00
}
2017-04-06 14:03:54 +02:00
_, err = tx.Exec(string(script))
2016-10-21 20:01:00 +02:00
if err != nil {
2019-10-28 13:01:29 +01:00
return errorf(err)
2016-10-21 20:01:00 +02:00
}
2019-11-12 13:01:36 +01:00
_, err = tx.Exec(`INSERT INTO ` + versionTable + ` (version) VALUES (` + strconv.Itoa(i) + `)`)
2016-10-21 20:01:00 +02:00
if err != nil {
2019-10-28 13:01:29 +01:00
return errorf(err)
2016-10-21 20:01:00 +02:00
}
}
2019-11-12 13:01:36 +01:00
if dbType == `pq` && o.Schema != `` {
_, err = tx.Exec(`SET search_path TO ` + searchPath)
if err != nil {
return err
}
}
2016-10-21 20:01:00 +02:00
err = tx.Commit()
if err != nil {
return err
}
return nil
}