@iamcalegari/mongoat / getStatus

Function: getStatus()

getStatus(database, config): Promise<MigrationStatusRow[]>

Defined in: src/migrate/runner.ts:741

Read-only migration status report: one row per discovered migration file, paired with whatever applied-state is known about it. Unlike runMigrations/revertMigration, this NEVER throws on checksum drift — it only flags it (drifted: true) so a caller (e.g. the CLI's status command) can surface a warning without blocking.

row.applied is true only for a record whose status === 'applied' — reconciled with collectPending's own find({ status: 'applied' }), so a migration is never simultaneously "applied" in status and "pending" for up. A status: 'failed' record is surfaced distinctly via row.failed, never rendered as applied.

Parameters

database

Database

A connected Database instance.

config

MigrateConfig

Migration directory and control collection name.

Returns

Promise<MigrationStatusRow[]>