sqlmigr

type Content struct {
	// UpCommand is the content for upgrade operation.
	UpCommand io.Reader
	// DownCommand is the content for rollback operation.
	DownCommand io.Reader
}

type Executor struct {
	// Logger logs each execution step
	Logger log.Logger
	// Provider provides all migrations for the current project.
	Provider MigrationProvider
	// Runner runs or reverts migrations for the current project.
	Runner MigrationRunner
	// Generator generates a migration file.
	Generator MigrationGenerator
}

type FileSystem = fs.FS

type Generator struct {
	// FileSystem is the file system where all sqlmigrs are created.
	FileSystem WriteFileSystem
}

type Migration struct {
	// Id is the primary key for this sqlmigr
	ID string `db:"id"`
	// Description is the short description of this sqlmigr.
	Description string `db:"description"`
	// CreatedAt returns the time of sqlmigr execution.
	CreatedAt time.Time `db:"created_at"`
	// Drivers return all supported drivers
	Drivers []string `db:"-"`
}

type MigrationGenerator interface {
	// Create creates a new sqlmigr.
	Create(m *Migration) error
	// Write creates a new sqlmigr for given content.
	Write(m *Migration, content *Content) error
}

type MigrationProvider interface {
	// Migrations returns all sqlmigr items.
	Migrations() ([]*Migration, error)
	// Insert inserts executed sqlmigr item in the sqlmigrs table.
	Insert(item *Migration) error
	// Delete deletes applied sqlmigr item from sqlmigrs table.
	Delete(item *Migration) error
	// Exists returns true if the sqlmigr exists
	Exists(item *Migration) bool
}

type MigrationRunner interface {
	// Run runs a given sqlmigr item.
	Run(item *Migration) error
	// Revert reverts a given sqlmigr item.
	Revert(item *Migration) error
}

type Provider struct {
	// FileSystem represents the project directory file system.
	FileSystem FileSystem
	// DB is a client to underlying database.
	DB *sqlx.DB
}

type Runner struct {
	// FileSystem represents the project directory file system.
	FileSystem FileSystem
	// DB is a client to underlying database.
	DB *sqlx.DB
}

type RunnerError struct {
	// Err the actual error
	Err error
	// Statement that cause the issue
	Statement string
}

type WriteFileSystem interface {
	FileSystem

	// OpenFile opens a new file
	OpenFile(string, int, fs.FileMode) (fs.File, error)
}