Outcome of a migration run, returned for logging and tests.

interface MigrationSummary {
    applied: number;
    errors: number;
    from: string;
    planned: number;
    stamped: boolean;
    to: string;
}

Properties

applied: number

The number of documents actually updated.

errors: number

The number of documents whose update threw and was skipped.

from: string

The version migrations were planned from.

planned: number

The number of migration steps in the plan.

stamped: boolean

Whether the stored migration version was advanced.

to: string

The target (running system) version.