Interface MigrationResult

interface MigrationResult {
    direction: MigrationDirection;
    migrationName: string;
    status: "NotExecuted" | "Success" | "Error";
}

Index

Properties

direction migrationName status

Properties

`Readonly`direction

direction: MigrationDirection

The direction in which this migration was executed.

`Readonly`migrationName

migrationName: string

`Readonly`status

status: "NotExecuted" | "Success" | "Error"

The execution status.

Success means the migration was successfully executed. Note that if any of the later migrations in the MigrationResult.results list failed (have status Error) AND the dialect supports transactional DDL, even the successfull migrations were rolled back.
Error means the migration failed. In this case the MigrationResult.error contains the error.
NotExecuted means that the migration was supposed to be executed but wasn't because an earlier migration failed.