migrations/io.github.octaviusframework.migrations.execution/MigrationInfo

MigrationInfo

class MigrationInfo(val version: MigrationVersion?, val description: String, val script: String, val origin: String?, val checksum: Long?, val status: MigrationStatus, val applied: AppliedMigration?)

One migration, as the run sees it: what it is, where it came from, and what is going to happen to it.

Constructors

MigrationInfo

internal constructor(version: MigrationVersion?, description: String, script: String, origin: String?, checksum: Long?, status: MigrationStatus, applied: AppliedMigration?)

Properties

applied

val applied: AppliedMigration?

The history row, where there is one.

checksum

val checksum: Long?

What the file hashes to now, or null for a class and for a migration that exists only in the history. The counterpart to AppliedMigration.checksum, which is what it hashed to when it ran - the two side by side are what a CHANGED status is reporting.

description

val description: String

What its name said.

label

val label: String

How this migration is named in a message: V2 add indexes, or R rebuild views.

origin

val origin: String?

Where the file or class was found, or null for one that exists only in the history - a migration whose file has been deleted has nowhere to point at.

script

val script: String

The file name or class name that identifies it.

status

val status: MigrationStatus

What is going to happen to it.

version

val version: MigrationVersion?

The version, or null for a repeatable migration.

Functions

toString

open override fun toString(): String