exposed-gradle-plugin/org.jetbrains.exposed.v1.gradle.plugin/GenerateMigrationsTask

GenerateMigrationsTask

abstract class GenerateMigrationsTask : DefaultTask

Task for generating SQL migration scripts from Exposed table definitions. Uses the Gradle Workers API for better isolation and parallel execution.

Constructors

GenerateMigrationsTask

constructor()

Properties

open var actions: List<Action<in Task?>?>?

open val ant: AntBuilder?

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject?

@get:InputFiles

abstract val classpath: ConfigurableFileCollection

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

@get:Internal

open override val convention: Convention?

databasePassword

@get:Input

@get:Optional

abstract val databasePassword: Property<String>

Optional password for the database connection, which should be considered as the current schema.

@get:Input

@get:Optional

abstract val databaseUrl: Property<String>

Optional URL for the database connection, which should be considered as the current schema.

@get:Input

@get:Optional

abstract val databaseUser: Property<String>

Optional username for the database connection, which should be considered as the current schema.

open val dependsOn: Set<Any?>?

open var description: String?

open val destroyables: TaskDestroyables?

open var didWork: Boolean

open var enabled: Boolean

open val extensions: ExtensionContainer?

@get:OutputDirectory

abstract val fileDirectory: DirectoryProperty

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

@get:Input

@get:Optional

abstract val fileExtension: Property<String>

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

@get:Input

@get:Optional

abstract val filePrefix: Property<String>

Optional prefix for migration script names. Defaults to "V".

@get:Input

@get:Optional

abstract val fileSeparator: Property<String>

Optional separator for migration script names. Defaults to "__".

fileVersionFormat

@get:Input

@get:Optional

abstract val fileVersionFormat: Property<VersionFormat>

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

open val finalizedBy: TaskDependency?

@get:Internal

var fullFileName: String?

open var group: String?

open val identityPath: Path?

impliesSubProjects

open var impliesSubProjects: Boolean

open val inputs: TaskInputsInternal?

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal?

open val localState: TaskLocalState?

open val logger: Logger?

open val logging: LoggingManager?

open val mustRunAfter: TaskDependency?

open val name: String?

open val onlyIf: Spec<in TaskInternal?>?

open val outputs: TaskOutputsInternal?

open val path: String?

open val project: Project?

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String?>?

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String?>?

requiredServices

open val requiredServices: TaskRequiredServices?

sharedResources

open val sharedResources: List<ResourceLock?>?

open val shouldRunAfter: TaskDependency?

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture?

open val state: TaskStateInternal?

@get:Input

abstract val tablesPackage: Property<String>

Package name where Exposed tables definitions are located.

open val taskActions: List<InputChangesAwareTaskAction?>?

taskDependencies

open val taskDependencies: TaskDependencyInternal?

open val taskIdentity: TaskIdentity<*>?

open val temporaryDir: File?

temporaryDirFactory

open val temporaryDirFactory: Factory<File?>?

testContainersImageName

@get:Input

@get:Optional

abstract val testContainersImageName: Property<String>

Optional Docker image name for when using TestContainers to apply existing scripts before generating new ones.

open val timeout: Property<Duration?>?

useUpperCaseDescription

@get:Input

@get:Optional

abstract val useUpperCaseDescription: Property<Boolean>

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

@get:Inject

abstract val workerExecutor: WorkerExecutor

The task's executor instance that accepts submitted work.

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec?>?)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task?>?)

open operator fun compareTo(otherTask: Task?): Int

open fun configure(closure: Closure<*>?): Task?

open fun dependsOn(vararg paths: Any?): Task?

open fun doFirst(action: Closure<*>?): Task?

open fun doFirst(action: Action<in Task?>?): Task?

open fun doFirst(actionName: String?, action: Action<in Task?>?): Task?

open fun doLast(action: Closure<*>?): Task?

open fun doLast(action: Action<in Task?>?): Task?

open fun doLast(actionName: String?, action: Action<in Task?>?): Task?

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String?)

open fun finalizedBy(vararg paths: Any?): Task?

generateMigrations

fun generateMigrations()

Submits a GenerateMigrationsWorker work to be executed in isolated contexts.

@Internal

open fun ~~getConvention~~(): Convention?

open fun hasProperty(propertyName: String?): Boolean

open fun hasTaskActions(): Boolean

open fun mustRunAfter(vararg paths: Any?): Task?

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String?)

open fun onlyIf(onlyIfClosure: Closure<*>?)

open fun onlyIf(spec: Spec<in Task?>?)

open fun onlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task?>?)

open fun property(propertyName: String?): Any?

open fun setDependsOn(dependsOn: Iterable<*>?)

open fun setFinalizedBy(finalizedByTasks: Iterable<*>?)

setFullFileName

fun setFullFileName(name: 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 with the specified name, which should include the required extension as well.

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>?)

open fun setOnlyIf(onlyIfClosure: Closure<*>?)

open fun setOnlyIf(spec: Spec<in Task?>?)

open fun setOnlyIf(onlyIfReason: String?, spec: Spec<in Task?>?)

open fun setProperty(name: String?, value: Any?)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>?)

open fun shouldRunAfter(vararg paths: Any?): TaskDependency?

open fun usesService(service: Provider<out BuildService<*>?>?)