exposed-maven-plugin/org.jetbrains.exposed.v1.maven.plugin/GenerateMigrationsMojo

GenerateMigrationsMojo

@Mojo(name = "generate-migrations", requiresDependencyResolution = ResolutionScope.RUNTIME, threadSafe = true)

@Execute(phase = LifecyclePhase.COMPILE)

class GenerateMigrationsMojo : AbstractMojo

Mojo for generating SQL migration scripts from Exposed table definitions.

Goal: exposed:generate-migrations.

Constructors

GenerateMigrationsMojo

constructor()

Properties

databasePassword

@Parameter(property = "exposed.migrations.databasePassword")

var databasePassword: String?

Password for the database connection. Required when testContainersImageName is not set.

databaseUrl

@Parameter(property = "exposed.migrations.databaseUrl")

var databaseUrl: String?

JDBC URL for the live database treated as the current schema. Required when testContainersImageName is not set.

databaseUser

@Parameter(property = "exposed.migrations.databaseUser")

var databaseUser: String?

Username for the database connection. Required when testContainersImageName is not set.

debug

@Parameter(property = "exposed.migrations.debug", defaultValue = "false")

var debug: Boolean

Whether to enable debug logging.

fileDirectory

@Parameter(property = "exposed.migrations.fileDirectory", defaultValue = "${project.basedir}/src/main/resources/db/migration")

lateinit var fileDirectory: File

Directory where generated migration scripts will be stored. Defaults to src/main/resources/db/migration relative to the project root.

fileExtension

@Parameter(property = "exposed.migrations.fileExtension", defaultValue = ".sql")

var fileExtension: String

File extension for migration scripts. Defaults to .sql.

filePrefix

@Parameter(property = "exposed.migrations.filePrefix", defaultValue = "V")

var filePrefix: String

Prefix for migration script names. Defaults to V.

fileSeparator

@Parameter(property = "exposed.migrations.fileSeparator", defaultValue = "__")

var fileSeparator: String

Separator for migration script names. Defaults to __.

fileVersionFormat

@Parameter(property = "exposed.migrations.fileVersionFormat", defaultValue = "TIMESTAMP_ONLY")

var fileVersionFormat: VersionFormat

Version format for migration script names. Defaults to using the full current timestamp (with seconds) in the format YYYYMMDDHHMMSS.

fullFileName

@Parameter(property = "exposed.migrations.filename")

var fullFileName: String?

Override that writes all migration statements to a single file with the given name. Must include the file extension. When set, all other filename configuration is ignored.

log

open var log: Log?

pluginContext

open var pluginContext: Map<*, *>?

tablesPackage

@Parameter(property = "exposed.migrations.tablesPackage")

var tablesPackage: String

Package name where Exposed table definitions are located. If multiple package names are required, pass all possible strings to the tablesPackages property instead. If the tablesPackage and tablesPackages properties have inconsistent elements, the final list of package names used will be a distinct combination of both properties' values.

tablesPackages

@Parameter(property = "exposed.migrations.tablesPackages")

var tablesPackages: List<String>

All package names where Exposed table definitions are located. If this property is not manually set, then it will be set to a list containing the single element package string configured for the property tablesPackage. If the tablesPackage property is not manually set, then this property defaults to an empty list and the task fails.

testContainersImageName

@Parameter(property = "exposed.migrations.testContainersImageName")

var testContainersImageName: String?

Docker image name. When set, a Testcontainer is started and existing scripts in fileDirectory are applied via Flyway before generating new ones. Mutually exclusive with the live-database connection parameters.

useUpperCaseDescription

@Parameter(property = "exposed.migrations.useUpperCaseDescription", defaultValue = "true")

var useUpperCaseDescription: Boolean

Whether the descriptive part of migration script names should be all upper-case. Defaults to true.

Functions

execute

open override fun execute()