org.flywaydb.gradle.task

Class FlywayCleanTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.flywaydb.gradle.task.FlywayCleanTask

All Implemented Interfaces:

Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

public class FlywayCleanTask
extends org.gradle.api.DefaultTask

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields

Modifier and Type	Field and Description
Boolean	allowMixedMigrations Whether to allow mixing transactional and non-transactional statements within the same migration.
String	baselineDescription The description to tag an existing schema with when executing baseline.
Boolean	baselineOnMigrate Whether to automatically call baseline when migrate is executed against a non-empty schema with no metadata table.
String	baselineVersion The version to tag an existing schema with when executing baseline.
String[]	callbacks An array of fully qualified FlywayCallback class implementations
Boolean	cleanDisabled Whether to disable clean.
Boolean	cleanOnValidationError Whether to automatically call clean or not when a validation error occurs
String	driver The fully qualified classname of the jdbc driver to use to connect to the database
String	encoding The encoding of Sql migrations
protected FlywayExtension	extension The flyway {} block in the build script.
Boolean	ignoreFutureMigrations Ignore future migrations when reading the metadata table.
Boolean	ignoreMissingMigrations Ignore missing migrations when reading the metadata table.
String	installedBy The username that will be recorded in the metadata table as having applied the migration.
String[]	locations Locations to scan recursively for migrations.
Boolean	outOfOrder Allows migrations to be run "out of order"
String	password The password to use to connect to the database
String	placeholderPrefix The prefix of every placeholder
Boolean	placeholderReplacement Whether placeholders should be replaced.
Map<Object,Object>	placeholders Placeholders to replace in Sql migrations
String	placeholderSuffix The suffix of every placeholder
String	repeatableSqlMigrationPrefix The file name prefix for repeatable sql migrations (default: R).
String[]	resolvers The fully qualified class names of the custom MigrationResolvers to be used in addition (default) or as a replacement (using skipDefaultResolvers) to the built-in ones for resolving Migrations to apply.
String[]	schemas The case-sensitive list of schemas managed by Flyway
Boolean	skipDefaultCallbacks If set to true, default built-in callbacks will be skipped, only custom migration callbacks will be used.
Boolean	skipDefaultResolvers If set to true, default built-in resolvers will be skipped, only custom migration resolvers will be used.
String	sqlMigrationPrefix The file name prefix for Sql migrations
String	sqlMigrationSeparator The file name prefix for Sql migrations
String	sqlMigrationSuffix The file name suffix for Sql migrations
String	table The name of Flyway's metadata table
String	target The target version up to which Flyway should consider migrations.
String	url The jdbc url to use to connect to the database
String	user The user to use to connect to the database
Boolean	validateOnMigrate Whether to automatically call validate or not when running migrate.

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
FlywayCleanTask()

Method Summary

Modifier and Type	Method and Description
protected Object	run(Flyway flyway) Executes the task's custom behavior.
Object	runTask()

Methods inherited from class org.gradle.api.internal.AbstractTask

addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getImpliesSubProjects, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setName, setOnlyIf, setOnlyIf, setProject, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

extension

protected FlywayExtension extension

The flyway {} block in the build script.

driver

public String driver

The fully qualified classname of the jdbc driver to use to connect to the database

url

public String url

The jdbc url to use to connect to the database

user

public String user

The user to use to connect to the database

password

public String password

The password to use to connect to the database

table

public String table

The name of Flyway's metadata table

schemas

public String[] schemas

The case-sensitive list of schemas managed by Flyway

baselineVersion

public String baselineVersion

The version to tag an existing schema with when executing baseline. (default: 1)

baselineDescription

public String baselineDescription

The description to tag an existing schema with when executing baseline. (default: << Flyway Baseline >>)

locations

public String[] locations

Locations to scan recursively for migrations. The location type is determined by its prefix. (default: filesystem:src/main/resources/db/migration)

Unprefixed locations or locations starting with classpath: point to a package on the classpath and may contain both sql and java-based migrations.

Locations starting with filesystem: point to a directory on the filesystem and may only contain sql migrations.

resolvers

public String[] resolvers

The fully qualified class names of the custom MigrationResolvers to be used in addition (default) or as a replacement (using skipDefaultResolvers) to the built-in ones for resolving Migrations to apply.

(default: none)

skipDefaultResolvers

public Boolean skipDefaultResolvers

If set to true, default built-in resolvers will be skipped, only custom migration resolvers will be used.

(default: false)

sqlMigrationPrefix

public String sqlMigrationPrefix

The file name prefix for Sql migrations

Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql

repeatableSqlMigrationPrefix

public String repeatableSqlMigrationPrefix

The file name prefix for repeatable sql migrations (default: R).

Repeatable sql migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix , which using the defaults translates to R__My_description.sql

sqlMigrationSeparator

public String sqlMigrationSeparator

The file name prefix for Sql migrations

Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql

sqlMigrationSuffix

public String sqlMigrationSuffix

The file name suffix for Sql migrations

Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1_1__My_description.sql

encoding

public String encoding

The encoding of Sql migrations

placeholders

public Map<Object,Object> placeholders

Placeholders to replace in Sql migrations

placeholderReplacement

public Boolean placeholderReplacement

Whether placeholders should be replaced.

placeholderPrefix

public String placeholderPrefix

The prefix of every placeholder

placeholderSuffix

public String placeholderSuffix

The suffix of every placeholder

target

public String target

The target version up to which Flyway should consider migrations. Migrations with a higher version number will be ignored. The special value current designates the current version of the schema.

callbacks

public String[] callbacks

An array of fully qualified FlywayCallback class implementations

skipDefaultCallbacks

public Boolean skipDefaultCallbacks

If set to true, default built-in callbacks will be skipped, only custom migration callbacks will be used.

(default: false)

outOfOrder

public Boolean outOfOrder

Allows migrations to be run "out of order"

validateOnMigrate

public Boolean validateOnMigrate

Whether to automatically call validate or not when running migrate. (default: true)

cleanOnValidationError

public Boolean cleanOnValidationError

Whether to automatically call clean or not when a validation error occurs

ignoreMissingMigrations

public Boolean ignoreMissingMigrations

Ignore missing migrations when reading the metadata table. These are migrations that were performed by an older deployment of the application that are no longer available in this version. For example: we have migrations available on the classpath with versions 1.0 and 3.0. The metadata table indicates that a migration with version 2.0 (unknown to us) has also been applied. Instead of bombing out (fail fast) with an exception, a warning is logged and Flyway continues normally. This is useful for situations where one must be able to deploy a newer version of the application even though it doesn't contain migrations included with an older one anymore. true to continue normally and log a warning, false to fail fast with an exception. (default: false)

ignoreFutureMigrations

public Boolean ignoreFutureMigrations

Ignore future migrations when reading the metadata table. These are migrations that were performed by a newer deployment of the application that are not yet available in this version. For example: we have migrations available on the classpath up to version 3.0. The metadata table indicates that a migration to version 4.0 (unknown to us) has already been applied. Instead of bombing out (fail fast) with an exception, a warning is logged and Flyway continues normally. This is useful for situations where one must be able to redeploy an older version of the application after the database has been migrated by a newer one. (default: true)

cleanDisabled

public Boolean cleanDisabled

Whether to disable clean. (default: false)

This is especially useful for production environments where running clean can be quite a career limiting move.

baselineOnMigrate

public Boolean baselineOnMigrate

Whether to automatically call baseline when migrate is executed against a non-empty schema with no metadata table. This schema will then be baselined with the baselineVersion before executing the migrations. Only migrations above baselineVersion will then be applied.

This is useful for initial Flyway production deployments on projects with an existing DB.

Be careful when enabling this as it removes the safety net that ensures Flyway does not migrate the wrong database in case of a configuration mistake!

true if baseline should be called on migrate for non-empty schemas, false if not. (default: false)

allowMixedMigrations

public Boolean allowMixedMigrations

Whether to allow mixing transactional and non-transactional statements within the same migration.

true if mixed migrations should be allowed. false if an error should be thrown instead. (default: false

installedBy

public String installedBy

The username that will be recorded in the metadata table as having applied the migration.

null for the current database user of the connection. (default: null).

Constructor Detail

FlywayCleanTask

public FlywayCleanTask()

Method Detail

run

protected Object run(Flyway flyway)

Executes the task's custom behavior.

runTask

public Object runTask()