migrator

README

sqlite-migrator

Documentation

Index

• func DefaultIDFunc(filename string) (uint32, error)
• type IDFunc
• type LogFunc
• type Migrator
  • func New(db *sql.DB, fs fs.ReadDirFS) *Migrator
  • func (m *Migrator) Migrate(ctx context.Context) error
  • func (m *Migrator) WithIDFunc(idFunc IDFunc) *Migrator
  • func (m *Migrator) WithLogFunc(logFunc LogFunc) *Migrator

Functions

func DefaultIDFunc

func DefaultIDFunc(filename string) (uint32, error)

DefaultIDFunc is the default IDFunc used by the migrator. It expects the filename to be in the YYYYMMDDHHMMSS_<description>.sql format and defines the ID as the number of seconds since 2023-01-01 00:00:00 UTC.

Types

type IDFunc

type IDFunc func(filename string) (uint32, error)

IDFunc defines a function that validates the migration filename and extracts its numeric ID. The ID must be unique and increasing with each new migration.

type LogFunc

type LogFunc func(msg string, attrs ...any)

LogFunc defines a function used to log the migration process. attrs is a list of key-value pairs, where the key is a string.

type Migrator

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

func New

func New(db *sql.DB, fs fs.ReadDirFS) *Migrator

func (*Migrator) Migrate

func (m *Migrator) Migrate(ctx context.Context) error

func (*Migrator) WithIDFunc

func (m *Migrator) WithIDFunc(idFunc IDFunc) *Migrator

func (*Migrator) WithLogFunc

func (m *Migrator) WithLogFunc(logFunc LogFunc) *Migrator