Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

migrations

package module

Go to main page

Versions in this module

v2

v2.1.2

Dec 5, 2023

v2.1.1

Nov 3, 2023

v2.1.0

Apr 13, 2023

Changes in this version

+ const EnvMigrations

+ var ErrNoCommand = errors.New("no SQL command found")

+ var ErrNoState = errors.New("no SQL parser state")

+ var ErrStopped = errors.New("stopped rollback due to /stop modifier")

+ func Applied(conn Queryable) ([]string, error)

+ func Apply(db *sql.DB) error

+ func ApplyRollbacks(db *sql.DB, revision int) error

+ func CopyMigrations(tx *sql.Tx) error

+ func CreateMigrationsApplied(tx *sql.Tx) error

+ func CreateMigrationsRollbacks(tx *sql.Tx) error

+ func CreateMigrationsSchema(tx *sql.Tx) error

+ func Downgrade(db *sql.DB) error

+ func HandleAsync(db *sql.DB, requests RequestChannel, results ResultChannel)

+ func HandleEmbeddedRollbacks(db *sql.DB, directory string, version int) error

+ func InitializeDB(db *sql.DB, directory string) error

+ func MissingMigrationsApplied(tx *sql.Tx) bool

+ func MissingMigrationsRollbacks(tx *sql.Tx) bool

+ func MissingMigrationsSchema(tx *sql.Tx) bool

+ func UpdateRollback(tx *sql.Tx, path string) error

+ func UpdateRollbacks(tx *sql.Tx, directory string) error

+ func Upgrade(tx *sql.Tx, directory string) error

+ type AsyncRequest struct

+ Direction Direction

+ Migration string

+ SQL SQL

+ Target int

+ type AsyncResult struct

+ Command SQL

+ Err error

+ Migration string

+ type Modifiers []string

+ func (m Modifiers) Has(value string) bool

+ type NilLogger struct

+ func (log *NilLogger) Debugf(string, ...interface{})

+ func (log *NilLogger) Infof(string, ...interface{})

+ type Options struct

+ Directory string

+ EmbeddedRollbacks bool

+ Revision int

+ func DefaultOptions() Options

+ func DisableEmbeddedRollbacks() Options

+ func WithDirectory(path string) Options

+ func WithRevision(revision int) Options

+ func (options Options) Apply(db *sql.DB) error

+ func (options Options) DisableEmbeddedRollbacks() Options

+ func (options Options) WithDirectory(path string) Options

+ func (options Options) WithRevision(revision int) Options

+ type Queryable interface

+ Query func(stmt string, args ...any) (*sql.Rows, error)

+ QueryRow func(query string, args ...any) *sql.Row

+ type RequestChannel chan AsyncRequest

+ type ResultChannel chan AsyncResult

+ type SQL string

+ func ParseSQL(doc SQL) ([]SQL, error)

+ func RunIsolated(db *sql.DB, req AsyncRequest) (SQL, error)

+ type SQLParser struct

+ func NewSQLParser(sql string) *SQLParser

+ func (p *SQLParser) Get() (SQL, error)

+ func (p *SQLParser) Next() bool

v2.0.3

Aug 19, 2020

Changes in this version

+ const Down

+ const Latest

+ const None

+ const Up

+ func Available(directory string, direction Direction) ([]string, error)

+ func Create(directory string, name string) error

+ func CreateSchemaMigrations(db *sql.DB) error

+ func Filename(path string) string

+ func IsDown(version int, desired int) bool

+ func IsMigrated(tx *sql.Tx, migration string) bool

+ func IsUp(version int, desired int) bool

+ func LatestMigration(db *sql.DB) (string, error)

+ func LatestRevision(directory string) int

+ func Migrate(db *sql.DB, directory string, version int) error

+ func Migrated(tx *sql.Tx, path string, direction Direction) error

+ func MissingSchemaMigrations(tx *sql.Tx) bool

+ func ReadSQL(path string, direction Direction) (string, error)

+ func Revision(filename string) (int, error)

+ func Rollback(db *sql.DB, directory string, steps int) error

+ func Run(tx *sql.Tx, path string, direction Direction) error

+ func ShouldRun(tx *sql.Tx, migration string, direction Direction, desiredVersion int) bool

+ type DefaultLogger struct

+ func (log *DefaultLogger) Debugf(format string, args ...interface{})

+ func (log *DefaultLogger) Infof(format string, args ...interface{})

+ type Direction string

+ func Moving(db *sql.DB, version int) Direction

+ type DiskReader struct

+ func (d *DiskReader) Files(directory string) ([]string, error)

+ func (d *DiskReader) Read(path string) (io.Reader, error)

+ type Logger interface

+ Debugf func(format string, args ...interface{})

+ Infof func(format string, args ...interface{})

+ var Log Logger

+ type Reader interface

+ Files func(directory string) ([]string, error)

+ Read func(path string) (io.Reader, error)

+ var ErrNameRequired = errors.New("name required")

+ var IO Reader

+ type SortDown []string

+ func (a SortDown) Len() int

+ func (a SortDown) Less(i, j int) bool

+ func (a SortDown) Swap(i, j int)

+ type SortUp []string

+ func (a SortUp) Len() int

+ func (a SortUp) Less(i, j int) bool

+ func (a SortUp) Swap(i, j int)

Other modules containing this package

github.com/sbowman/migrations