Framework
MigrationRunner
Class: MigrationRunner
Migration runner class.
Handles:
- Lock acquisition/release
- Pending migration discovery
- Migration execution with status tracking
- Rollback on failure
- Dry-run mode
Constructors
new MigrationRunner()
new MigrationRunner(adapter, options?): MigrationRunnerParameters
| Parameter | Type |
|---|---|
adapter | FlashcoreAdapter<string, unknown> |
options? | MigrationRunnerOptions |
Returns
Methods
forceUnlock()
forceUnlock(): Promise<boolean>Force unlock the migration lock.
Returns
Promise<boolean>
True if unlocked
getStatus()
getStatus(): Promise<MigrationStatusReport>Get the current migration status report.
Returns
Promise<MigrationStatusReport>
Status report with pending, completed, and failed migrations
rollback()
rollback(migrationName): Promise<MigrationResult>Roll back a specific migration.
Parameters
| Parameter | Type | Description |
|---|---|---|
migrationName | string | Name of migration to roll back |
Returns
Promise<MigrationResult>
Result of rollback attempt
runPending()
runPending(options): Promise<MigrationResult[]>Run all pending migrations.
Parameters
| Parameter | Type | Description |
|---|---|---|
options | MigrationRunOptions | Run options (dryRun, forceUnlock, target) |
Returns
Promise<MigrationResult[]>
Results for each migration attempted