migrations/io.github.octaviusframework.migrations

Package-level declarations

Types

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

Exception thrown when a migration run cannot go on.

MigrationExceptionReason

enum MigrationExceptionReason : Enum<MigrationExceptionReason>

Why a migration run stopped.

MigrationVersion

class MigrationVersion : Comparable<MigrationVersion>

A migration's version, ordered the way version numbers are ordered rather than the way text is.

MigratorConfig

data class MigratorConfig(val sqlLocations: List<String> = listOf("db/migration"), val codePackages: List<String> = emptyList(), val classLoader: ClassLoader? = null, val historySchema: String = "public", val historyTable: String = "octavius_migration_history", val lockTimeout: Duration = 30.seconds, val outOfOrder: Boolean = false, val baselineVersion: String? = null, val target: String? = null)

Where the migrator looks and what it accepts.

OctaviusMigration

interface OctaviusMigration

A migration written in Kotlin rather than in .sql.

OctaviusMigrator

class OctaviusMigrator

Brings a database up to date with the migrations in this application.