GenerateMigrationsParameters

interface GenerateMigrationsParameters : WorkParameters

Parameter objects for the migrations extension's work actions.

Members

Properties

classpathUrls

Link copied to clipboard

abstract var classpathUrls: List<URL>

Optional classpath that is scanned for Exposed table definitions. Defaults to the project's runtime classpath.

databasePassword

Link copied to clipboard

abstract var databasePassword: String?

Password for the database connection, which should be considered as the current schema. This is optional only if testContainersImageName is not set.

databaseUrl

Link copied to clipboard

abstract var databaseUrl: String?

URL for the database connection, which should be considered as the current schema. This is optional only if testContainersImageName is not set.

databaseUser

Link copied to clipboard

abstract var databaseUser: String?

Username for the database connection, which should be considered as the current schema. This is optional only if testContainersImageName is not set.

debug

Link copied to clipboard

abstract var debug: Boolean

Whether logger DEBUG level is enabled.

fileDirectory

Link copied to clipboard

abstract val fileDirectory: DirectoryProperty

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

fileExtension

Link copied to clipboard

abstract var fileExtension: String

Optional file extension for migration scripts. Defaults to .sql.

filePrefix

Link copied to clipboard

abstract var filePrefix: String

Optional prefix for migration script names. Defaults to V.

fileSeparator

Link copied to clipboard

abstract var fileSeparator: String

Optional separator for migration script names. Defaults to __.

fileVersionFormat

Link copied to clipboard

abstract var fileVersionFormat: VersionFormat

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

fullFileName

Link copied to clipboard

abstract var fullFileName: String?

Optional command line argument that overrides any filename configurations declared in the build file. Passing an argument to this option means all migration statements will be stored in a single generated file of this name, which should include the required extension as well.

tablesPackage

Link copied to clipboard

abstract var tablesPackage: String

Package name where Exposed table definitions are expected to be located.

testContainersImageName

Link copied to clipboard

abstract var testContainersImageName: String?

Docker image name for when using TestContainers to apply existing scripts before generating new ones. This is optional only if no values are set for any database properties.

useUpperCaseDescription

Link copied to clipboard

abstract var useUpperCaseDescription: Boolean

Optional flag for whether the descriptive part of migration script names should be all in upper-case. Defaults to true.