migrations/io.github.octaviusframework.migrations.execution/MigrationStatus

MigrationStatus

enum MigrationStatus : Enum<MigrationStatus>

What is going to happen to one migration, or what already has.

Wider than the reason enum on MigrationException on purpose. That one is keyed on in a log; this one is the answer to "what about this migration", and every value here is a different answer.

Entries

PENDING

Not applied yet. The next run will apply it.

OUT_OF_ORDER

Not applied yet, and its version is below one that already has been - somebody merged a branch late. The run refuses unless MigratorConfig.outOfOrder says to allow it, in which case it simply runs.

APPLIED

Applied, unchanged since. Nothing to do.

CHANGED

Applied and changed since, which the run refuses. A migration the database has already run is a migration whose text is a record of what was done, not a draft.

MISSING

The database has run it and there is no file or class for it any more, which the run refuses.

INCOMPLETE

A previous run died part-way through it, and the run refuses until somebody has looked.

BELOW_BASELINE

Below the version this database was adopted at, so it is taken as already run.

ABOVE_TARGET

Above MigratorConfig.target, so this run stops before it.

Properties

entries

val entries: EnumEntries<MigrationStatus>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): MigrationStatus

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<MigrationStatus>

Returns an array containing the constants of this enum type, in the order they're declared.