type GetMigrationResult struct {
	IsApplied bool
	Timestamp time.Time
}

type ListMigrationsResult struct {
	Version   int64
	IsApplied bool
}

type Store interface {
	// CreateVersionTable creates the version table within a transaction. This table is used to
	// record applied migrations.
	CreateVersionTable(ctx context.Context, db sqlextended.DBTxConn) error

	// InsertOrDelete inserts or deletes a version id from the version table.
	InsertOrDelete(ctx context.Context, db sqlextended.DBTxConn, direction bool, version int64) error

	// GetMigration retrieves a single migration by version id.
	//
	// Returns the raw sql error if the query fails. It is the callers responsibility to assert for
	// the correct error, such as [sql.ErrNoRows].
	GetMigration(ctx context.Context, db sqlextended.DBTxConn, version int64) (*GetMigrationResult, error)

	// ListMigrations retrieves all migrations sorted in descending order by id.
	//
	// If there are no migrations, an empty slice is returned with no error.
	ListMigrations(ctx context.Context, db sqlextended.DBTxConn) ([]*ListMigrationsResult, error)
}