migration

type CLIOptions func(*cliOption)

type ExecutableScanner interface {
	// Exec executes a SQL command with the provided arguments.
	// Returns an error if the execution fails.
	Exec(ctx context.Context, sql string, arguments ...any) error

	// Scan executes a SQL query with the provided arguments and returns the result rows.
	// Returns an error if the query fails or if scanning the results encounters an issue.
	Scan(ctx context.Context, sql string, arguments ...any) (Rows, error)
}

type Migrated struct {
	Name      string    `db:"name"`
	Stage     string    `db:"stage"`
	CreatedAt time.Time `db:"created_at"`
}

type Migration interface {
	// Load loads migration stages from the filesystem and caches them.
	Load() error

	// Root returns the root directory of migration files.
	Root() string

	// Extension returns the file extension for migration files.
	Extension() string

	// IsDev indicates if it is in development mode.
	IsDev() bool

	// Initialize sets up the database migration table.
	Initialize() error

	// Summary returns an overview of the migration.
	Summary() (Summary, error)

	// Up applies migration stages.
	Up(stages []string, options ...MigrationOption) (Summary, error)

	// Down rolls back migration stages.
	Down(stages []string, options ...MigrationOption) (Summary, error)

	// Refresh rolls back and reapplies migration stages.
	Refresh(stages []string, options ...MigrationOption) (Summary, error)
}

type MigrationOption func(*migrationOption)

type MigrationSource interface {
	// Transaction runs a function within a transaction context.
	// The transaction is committed if the function succeeds, or rolled back in case of an error.
	Transaction(ctx context.Context, callback func(ExecutableScanner) error) error

	// Exec executes a SQL command with the provided arguments.
	// Returns an error if the execution fails.
	Exec(ctx context.Context, sql string, arguments ...any) error

	// Scan executes a SQL query with the provided arguments and returns the result rows.
	// Returns an error if the query fails or if scanning the results encounters an issue.
	Scan(ctx context.Context, sql string, arguments ...any) (Rows, error)
}

type Option func(*migration)

type Rows interface {
	// Next prepares the next row for reading.
	// Returns true if there is a next row, false if there are no more rows.
	Next() bool

	// Scan reads the current row's columns into the provided destination variables.
	// Returns an error if scanning the row fails.
	Scan(dest ...any) error

	// Close releases resources associated with the Rows.
	// It prevents further row enumeration after being called.
	Close()
}

type Summary []Migrated