migo

README

migo

A sql db migrations library for go

Documentation

Index

• func Migrate(db *sql.DB, fsys fs.FS) error
• func MigrateCtx(ctx context.Context, db *sql.DB, fsys fs.FS) error
• func Purge(db *sql.DB) error
• func PurgeCtx(ctx context.Context, db *sql.DB) error

Functions

func Migrate

func Migrate(db *sql.DB, fsys fs.FS) error

Migrate is equivalent to calling MigrateCtx(context.TODO(), db, fsys)

func MigrateCtx

func MigrateCtx(ctx context.Context, db *sql.DB, fsys fs.FS) error

MigrateCtx takes a fs.FS containing sql files and runs all .sql files not ending with _rollback.sql on the provided db. Migration files should begin with an integer, optionally followed by an underscore and a description, and end with .sql. Migration files must not end with _rollback.sql

func Purge

func Purge(db *sql.DB) error

Purge is equivalent to calling PurgeCtx(context.TODO(), db)

func PurgeCtx

func PurgeCtx(ctx context.Context, db *sql.DB) error

PurgeCtx deletes all migo specific information from the db, leaving previously run migrations intact