migrations/io.github.octaviusframework.migrations.history/MigrationState

MigrationState

enum MigrationState : Enum<MigrationState>

Where a migration got to.

A transactional migration is only ever SUCCESS here: it wrote its row inside the transaction that ran it, so a failure took the row with it and left no trace. The other two belong to migrations that ran without one, where the database really is part-way and only a person can say what to do about it.

Entries

RUNNING

Started and not heard from since - written before the first statement of a migration that runs outside a transaction. A row still saying this on the next run means the process died in the middle of it.

SUCCESS

Finished.

FAILED

A statement failed, and the ones before it in the same file had already been committed.

Properties

entries

val entries: EnumEntries<MigrationState>

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): MigrationState

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<MigrationState>

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