dbschema

Documentation

Overview

Helpers for building a database schema using migration files

Index

• func Build(ctx context.Context, db *sql.DB, schemaFiles fs.FS) error
• type TooNew
  • func (e *TooNew) Error() string

Functions

func Build

func Build(ctx context.Context, db *sql.DB, schemaFiles fs.FS) error

Build a database schema by successively applying migration files as necessary.

schemaFiles must contain .sql files with consecutive numeric names like 001.sql, 002.sql, and so on. Files without a .sql suffix are ignored.

The database's current schema version is stored in the dbschema table.

Types

type TooNew

type TooNew struct {
	CurrentVersion int
	LatestVersion  int
}

TooNew is the error returned by Build when the database contains a schema version that is newer than the newest schema file.

func (*TooNew) Error

func (e *TooNew) Error() string