migrations/io.github.octaviusframework.migrations/MigrationException

MigrationException

class MigrationException(val reason: MigrationExceptionReason, val details: String? = null, cause: Throwable? = null) : OctaviusException

Exception thrown when a migration run cannot go on.

It carries no sqlState: where the server said something - a lock wait that ran out, a statement of a migration it refused - its exception is the cause. Where the migrator has no opinion - the history table failing to be read, a connection dying mid-run - the driver's own exception comes through instead.

Parameters

cause

The failure underneath, where this one is standing in front of another.

Constructors

MigrationException

constructor(reason: MigrationExceptionReason, details: String? = null, cause: Throwable? = null)

Properties

open val cause: Throwable?

val details: String?

What is actually wrong, naming the file, class or version it is wrong about.

open val message: String?

val path: MutableList<String>

var queryContext: QueryContext?

val reason: MigrationExceptionReason

What kind of problem this is, for a log line to be keyed on.

serverErrorMessage

val serverErrorMessage: ServerErrorMessage?

val sqlState: String?

Functions

getDetailedMessage

open override fun getDetailedMessage(): String

open override fun toString(): String