/*
* Copyright 2010-2020 Redgate Software Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.flywaydb.core.api.configuration;
import org.flywaydb.core.api.ErrorCode;
import org.flywaydb.core.api.FlywayException;
import org.flywaydb.core.api.Location;
import org.flywaydb.core.api.MigrationVersion;
import org.flywaydb.core.api.callback.Callback;
import org.flywaydb.core.api.logging.Log;
import org.flywaydb.core.api.logging.LogFactory;
import org.flywaydb.core.api.migration.JavaMigration;
import org.flywaydb.core.api.resolver.MigrationResolver;
import org.flywaydb.core.internal.configuration.ConfigUtils;
import org.flywaydb.core.internal.jdbc.DriverDataSource;
import org.flywaydb.core.internal.license.Edition;
import org.flywaydb.core.internal.util.ClassUtils;
import org.flywaydb.core.internal.util.Locations;
import org.flywaydb.core.internal.util.StringUtils;
import javax.sql.DataSource;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import static org.flywaydb.core.internal.configuration.ConfigUtils.removeBoolean;
import static org.flywaydb.core.internal.configuration.ConfigUtils.removeInteger;
JavaBean-style configuration for Flyway. This is primarily meant for compatibility with scenarios where the
new FluentConfiguration isn't an easy fit, such as Spring XML bean configuration.
This configuration can then be passed to Flyway using the new Flyway(Configuration)
constructor.
/**
* JavaBean-style configuration for Flyway. This is primarily meant for compatibility with scenarios where the
* new FluentConfiguration isn't an easy fit, such as Spring XML bean configuration.
* <p>
* This configuration can then be passed to Flyway using the <code>new Flyway(Configuration)</code> constructor.
* </p>
*/
public class ClassicConfiguration implements Configuration {
private static final Log LOG = LogFactory.getLog(ClassicConfiguration.class);
private String driver;
private String url;
private String user;
private String password;
The dataSource to use to access the database. Must have the necessary privileges to execute ddl.
/**
* The dataSource to use to access the database. Must have the necessary privileges to execute ddl.
*/
private DataSource dataSource;
The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will
wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries.
(default: 0)
/**
* The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will
* wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries.
* (default: 0)
*/
private int connectRetries;
The SQL statements to run to initialize a new database connection immediately after opening it. (default: null
) /**
* The SQL statements to run to initialize a new database connection immediately after opening it.
* (default: {@code null})
*/
private String initSql;
The ClassLoader to use for resolving migrations on the classpath. (default: Thread.currentThread().getContextClassLoader() )
/**
* The ClassLoader to use for resolving migrations on the classpath. (default: Thread.currentThread().getContextClassLoader() )
*/
private ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
The locations to scan recursively for migrations.
The location type is determined by its prefix. 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.
(default: db/migration)
/**
* The locations to scan recursively for migrations.
* <p>The location type is determined by its prefix.
* Unprefixed locations or locations starting with {@code classpath:} point to a package on the classpath and may
* contain both sql and java-based migrations.
* Locations starting with {@code filesystem:} point to a directory on the filesystem and may only contain sql
* migrations.</p>
* <p>
* (default: db/migration)
*/
private Locations locations = new Locations("db/migration");
The encoding of Sql migrations. (default: UTF-8)
/**
* The encoding of Sql migrations. (default: UTF-8)
*/
private Charset encoding = StandardCharsets.UTF_8;
The default schema managed by Flyway. This schema name is case-sensitive. If not specified, but
schemaNames is, Flyway uses the first schema in that list. If that is also not specified, Flyway uses
the default schema for the database connection.
Consequences:
- This schema will be the one containing the schema history table.
- This schema will be the default for the database connection (provided the database supports this concept).
/**
* The default schema managed by Flyway. This schema name is case-sensitive. If not specified, but
* <i>schemaNames</i> is, Flyway uses the first schema in that list. If that is also not specified, Flyway uses
* the default schema for the database connection.
* <p>Consequences:</p>
* <ul>
* <li>This schema will be the one containing the schema history table.</li>
* <li>This schema will be the default for the database connection (provided the database supports this concept).</li>
* </ul>
*/
private String defaultSchemaName = null;
The schemas managed by Flyway. These schema names are case-sensitive. If not specified, Flyway uses
the default schema for the database connection. If defaultSchemaName is not specified, then the first of
this list also acts as default schema.
Consequences:
- Flyway will automatically attempt to create all these schemas, unless they already exist.
- The schemas will be cleaned in the order of this list.
- If Flyway created them, the schemas themselves will be dropped when cleaning.
/**
* The schemas managed by Flyway. These schema names are case-sensitive. If not specified, Flyway uses
* the default schema for the database connection. If <i>defaultSchemaName</i> is not specified, then the first of
* this list also acts as default schema.
* <p>Consequences:</p>
* <ul>
* <li>Flyway will automatically attempt to create all these schemas, unless they already exist.</li>
* <li>The schemas will be cleaned in the order of this list.</li>
* <li>If Flyway created them, the schemas themselves will be dropped when cleaning.</li>
* </ul>
*/
private String[] schemaNames = {};
The name of the schema history table that will be used by Flyway. (default: flyway_schema_history)
By default
(single-schema mode) the schema history table is placed in the default schema for the connection provided by the
datasource.
When the flyway.schemas property is set (multi-schema mode), the schema history table is
placed in the first schema of the list.
/**
* <p>The name of the schema history table that will be used by Flyway. (default: flyway_schema_history)</p><p> By default
* (single-schema mode) the schema history table is placed in the default schema for the connection provided by the
* datasource. </p> <p>When the <i>flyway.schemas</i> property is set (multi-schema mode), the schema history table is
* placed in the first schema of the list. </p>
*/
private String table = "flyway_schema_history";
The tablespace where to create the schema history table that will be used by Flyway.
If not specified, Flyway uses the default tablespace for the database connection.
This setting is only relevant for databases that do support the notion of tablespaces. Its value is simply
ignored for all others.
/**
* <p>The tablespace where to create the schema history table that will be used by Flyway.</p>
* <p>If not specified, Flyway uses the default tablespace for the database connection.
* This setting is only relevant for databases that do support the notion of tablespaces. Its value is simply
* ignored for all others.</p>
*/
private String tablespace;
The target version up to which Flyway should consider migrations.
Migrations with a higher version number will be ignored.
Special values:
current
: designates the current version of the schema
latest
: the latest version of the schema, as defined by the migration with the highest version
Defaults to latest
. /**
* The target version up to which Flyway should consider migrations.
* Migrations with a higher version number will be ignored.
* Special values:
* <ul>
* <li>{@code current}: designates the current version of the schema</li>
* <li>{@code latest}: the latest version of the schema, as defined by the migration with the highest version</li>
* </ul>
* Defaults to {@code latest}.
*/
private MigrationVersion target;
Whether placeholders should be replaced. (default: true)
/**
* Whether placeholders should be replaced. (default: true)
*/
private boolean placeholderReplacement = true;
The map of <placeholder, replacementValue> to apply to sql migration scripts.
/**
* The map of <placeholder, replacementValue> to apply to sql migration scripts.
*/
private Map<String, String> placeholders = new HashMap<>();
The prefix of every placeholder. (default: ${ )
/**
* The prefix of every placeholder. (default: ${ )
*/
private String placeholderPrefix = "${";
The suffix of every placeholder. (default: } )
/**
* The suffix of every placeholder. (default: } )
*/
private String placeholderSuffix = "}";
The file name prefix for versioned SQL migrations. (default: V)
Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
which using the defaults translates to V1_1__My_description.sql
/**
* The file name prefix for versioned SQL migrations. (default: V)
* <p>
* <p>Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
* which using the defaults translates to V1_1__My_description.sql</p>
*/
private String sqlMigrationPrefix = "V";
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
/**
* The file name prefix for repeatable SQL migrations. (default: R)
* <p>
* <p>Repeatable sql migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix ,
* which using the defaults translates to R__My_description.sql</p>
*/
private String repeatableSqlMigrationPrefix = "R";
The file name separator for sql migrations. (default: __)
Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
which using the defaults translates to V1_1__My_description.sql
/**
* The file name separator for sql migrations. (default: __)
* <p>
* <p>Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
* which using the defaults translates to V1_1__My_description.sql</p>
*/
private String sqlMigrationSeparator = "__";
The file name suffixes for SQL migrations. (default: .sql)
SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
which using the defaults translates to V1_1__My_description.sql
Multiple suffixes (like .sql,.pkg,.pkb) can be specified for easier compatibility with other tools such as
editors with specific file associations.
/**
* The file name suffixes for SQL migrations. (default: .sql)
* <p>SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
* which using the defaults translates to V1_1__My_description.sql</p>
* <p>Multiple suffixes (like .sql,.pkg,.pkb) can be specified for easier compatibility with other tools such as
* editors with specific file associations.</p>
*/
private String[] sqlMigrationSuffixes = {".sql"};
The manually added Java-based migrations. These are not Java-based migrations discovered through classpath
scanning and instantiated by Flyway. Instead these are manually added instances of JavaMigration.
This is particularly useful when working with a dependency injection container, where you may want the DI
container to instantiate the class and wire up its dependencies for you. (default: none)
/**
* The manually added Java-based migrations. These are not Java-based migrations discovered through classpath
* scanning and instantiated by Flyway. Instead these are manually added instances of JavaMigration.
* This is particularly useful when working with a dependency injection container, where you may want the DI
* container to instantiate the class and wire up its dependencies for you. (default: none)
*/
private JavaMigration[] javaMigrations = {};
Ignore missing migrations when reading the schema history 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 schema history 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.
Note that if the most recently applied migration is removed, Flyway has no way to know it is missing and will
mark it as future instead.
true
to continue normally and log a warning, false
to fail fast with an exception. (default: false
)
/**
* Ignore missing migrations when reading the schema history 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 schema history 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.
* Note that if the most recently applied migration is removed, Flyway has no way to know it is missing and will
* mark it as future instead.
* <p>
* {@code true} to continue normally and log a warning, {@code false} to fail fast with an exception.
* (default: {@code false})
*/
private boolean ignoreMissingMigrations;
Ignore ignored migrations when reading the schema history table. These are migrations that were added in between
already migrated migrations in this version. For example: we have migrations available on the classpath with
versions from 1.0 to 3.0. The schema history table indicates that version 1 was finished on 1.0.15, and the next
one was 2.0.0. But with the next release a new migration was added to version 1: 1.0.16. Such scenario is ignored
by migrate command, but by default is rejected by validate. When ignoreIgnoredMigrations is enabled, such case
will not be reported by validate command. This is useful for situations where one must be able to deliver
complete set of migrations in a delivery package for multiple versions of the product, and allows for further
development of older versions.
true
to continue normally, false
to fail fast with an exception. (default: false
)
/**
* Ignore ignored migrations when reading the schema history table. These are migrations that were added in between
* already migrated migrations in this version. For example: we have migrations available on the classpath with
* versions from 1.0 to 3.0. The schema history table indicates that version 1 was finished on 1.0.15, and the next
* one was 2.0.0. But with the next release a new migration was added to version 1: 1.0.16. Such scenario is ignored
* by migrate command, but by default is rejected by validate. When ignoreIgnoredMigrations is enabled, such case
* will not be reported by validate command. This is useful for situations where one must be able to deliver
* complete set of migrations in a delivery package for multiple versions of the product, and allows for further
* development of older versions.
* <p>
* {@code true} to continue normally, {@code false} to fail fast with an exception.
* (default: {@code false})
*/
private boolean ignoreIgnoredMigrations;
Ignore pending migrations when reading the schema history table. These are migrations that are available on the
classpath but have not yet been performed by an application deployment.
This can be useful for verifying that in-development migration changes don't contain any validation-breaking changes
of migrations that have already been applied to a production environment, e.g. as part of a CI/CD process, without
failing because of the existence of new migration versions.
true
to continue normally, false
to fail fast with an exception. (default: false
)
/**
* Ignore pending migrations when reading the schema history table. These are migrations that are available on the
* classpath but have not yet been performed by an application deployment.
* This can be useful for verifying that in-development migration changes don't contain any validation-breaking changes
* of migrations that have already been applied to a production environment, e.g. as part of a CI/CD process, without
* failing because of the existence of new migration versions.
* <p>
* {@code true} to continue normally, {@code false} to fail fast with an exception.
* (default: {@code false})
*/
private boolean ignorePendingMigrations;
Ignore future migrations when reading the schema history 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 schema history 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
) /**
* Ignore future migrations when reading the schema history 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 schema history 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: {@code true})
*/
private boolean ignoreFutureMigrations = true;
Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention. A failure can be useful to check that errors such as case sensitivity in migration prefixes have been corrected. false
to continue normally, true
to fail fast with an exception. (default: false
) /**
* Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention. A failure can be
* useful to check that errors such as case sensitivity in migration prefixes have been corrected.
* {@code false} to continue normally, {@code true} to fail fast with an exception. (default: {@code false})
*/
private boolean validateMigrationNaming = false;
Whether to automatically call validate or not when running migrate. (default: true
) /**
* Whether to automatically call validate or not when running migrate. (default: {@code true})
*/
private boolean validateOnMigrate = true;
Whether to automatically call clean or not when a validation error occurs. (default: false
) This is exclusively intended as a convenience for development. even though we
strongly recommend not to change migration scripts once they have been checked into SCM and run, this provides a
way of dealing with this case in a smooth manner. The database will be wiped clean automatically, ensuring that
the next migration will bring you back to the state checked into SCM.
Warning ! Do not enable in production !
/**
* Whether to automatically call clean or not when a validation error occurs. (default: {@code false})
* <p> This is exclusively intended as a convenience for development. even though we
* strongly recommend not to change migration scripts once they have been checked into SCM and run, this provides a
* way of dealing with this case in a smooth manner. The database will be wiped clean automatically, ensuring that
* the next migration will bring you back to the state checked into SCM.</p>
* <p><b>Warning ! Do not enable in production !</b></p>
*/
private boolean cleanOnValidationError;
Whether to disable clean. (default: false
) This is especially useful for production environments where running clean can be quite a career limiting move.
/**
* Whether to disable clean. (default: {@code false})
* <p>This is especially useful for production environments where running clean can be quite a career limiting move.</p>
*/
private boolean cleanDisabled;
The version to tag an existing schema with when executing baseline. (default: 1)
/**
* The version to tag an existing schema with when executing baseline. (default: 1)
*/
private MigrationVersion baselineVersion = MigrationVersion.fromVersion("1");
The description to tag an existing schema with when executing baseline. (default: << Flyway Baseline >>)
/**
* The description to tag an existing schema with when executing baseline. (default: << Flyway Baseline >>)
*/
private String baselineDescription = "<< Flyway Baseline >>";
Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table. This schema will then be initialized 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! (default: false
)
/**
* <p>
* Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table.
* This schema will then be initialized with the {@code baselineVersion} before executing the migrations.
* Only migrations above {@code baselineVersion} will then be applied.
* </p>
* <p>
* This is useful for initial Flyway production deployments on projects with an existing DB.
* </p>
* <p>
* 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! (default: {@code false})
* </p>
*/
private boolean baselineOnMigrate;
Allows migrations to be run "out of order".
If you already have versions 1 and 3 applied, and now a version 2 is found,
it will be applied too instead of being ignored.
(default: false
)
/**
* Allows migrations to be run "out of order".
* <p>If you already have versions 1 and 3 applied, and now a version 2 is found,
* it will be applied too instead of being ignored.</p>
* <p>(default: {@code false})</p>
*/
private boolean outOfOrder;
This is a list of custom callbacks that fire before and after tasks are executed. You can
add as many custom callbacks as you want. (default: none)
/**
* This is a list of custom callbacks that fire before and after tasks are executed. You can
* add as many custom callbacks as you want. (default: none)
*/
private final List<Callback> callbacks = new ArrayList<>();
Whether Flyway should skip the default callbacks. If true, only custom callbacks are used.
(default: false)
/**
* Whether Flyway should skip the default callbacks. If true, only custom callbacks are used.
* <p>(default: false)</p>
*/
private boolean skipDefaultCallbacks;
The custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
(default: none)
/**
* The custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
* <p>(default: none)</p>
*/
private MigrationResolver[] resolvers = new MigrationResolver[0];
Whether Flyway should skip the default resolvers. If true, only custom resolvers are used.
(default: false)
/**
* Whether Flyway should skip the default resolvers. If true, only custom resolvers are used.
* <p>(default: false)</p>
*/
private boolean skipDefaultResolvers;
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
)
/**
* Whether to allow mixing transactional and non-transactional statements within the same migration.
* <p>
* {@code true} if mixed migrations should be allowed. {@code false} if an error should be thrown instead. (default: {@code false})
*/
private boolean mixed;
Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).
true
if migrations should be grouped. false
if they should be applied individually instead. (default: false
)
/**
* Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).
* <p>
* {@code true} if migrations should be grouped. {@code false} if they should be applied individually instead. (default: {@code false})
*/
private boolean group;
The username that will be recorded in the schema history table as having applied the migration.
null
for the current database user of the connection. (default: null
).
/**
* The username that will be recorded in the schema history table as having applied the migration.
* <p>
* {@code null} for the current database user of the connection. (default: {@code null}).
*/
private String installedBy;
Creates a new default configuration.
/**
* Creates a new default configuration.
*/
public ClassicConfiguration() {
// Nothing to do.
}
Creates a new default configuration with this classloader.
Params: - classLoader – The ClassLoader to use for loading migrations, resolvers, etc from the classpath. (default: Thread.currentThread().getContextClassLoader() )
/**
* Creates a new default configuration with this classloader.
*
* @param classLoader The ClassLoader to use for loading migrations, resolvers, etc from the classpath. (default: Thread.currentThread().getContextClassLoader() )
*/
public ClassicConfiguration(ClassLoader classLoader) {
if (classLoader != null) {
this.classLoader = classLoader;
}
}
Creates a new configuration with the same values as this existing one.
Params: - configuration – The configuration to use.
/**
* Creates a new configuration with the same values as this existing one.
*
* @param configuration The configuration to use.
*/
public ClassicConfiguration(Configuration configuration) {
this(configuration.getClassLoader());
configure(configuration);
}
@Override
public Location[] getLocations() {
return locations.getLocations().toArray(new Location[0]);
}
@Override
public Charset getEncoding() {
return encoding;
}
@Override
public String getDefaultSchema() { return defaultSchemaName; }
@Override
public String[] getSchemas() { return schemaNames; }
@Override
public String getTable() {
return table;
}
@Override
public String getTablespace() {
return tablespace;
}
@Override
public MigrationVersion getTarget() {
return target;
}
@Override
public boolean isPlaceholderReplacement() {
return placeholderReplacement;
}
@Override
public Map<String, String> getPlaceholders() {
return placeholders;
}
@Override
public String getPlaceholderPrefix() {
return placeholderPrefix;
}
@Override
public String getPlaceholderSuffix() {
return placeholderSuffix;
}
@Override
public String getSqlMigrationPrefix() {
return sqlMigrationPrefix;
}
@Override
public String getRepeatableSqlMigrationPrefix() {
return repeatableSqlMigrationPrefix;
}
@Override
public String getSqlMigrationSeparator() {
return sqlMigrationSeparator;
}
@Override
public String[] getSqlMigrationSuffixes() {
return sqlMigrationSuffixes;
}
@Override
public JavaMigration[] getJavaMigrations() {
return javaMigrations;
}
@Override
public boolean isIgnoreMissingMigrations() {
return ignoreMissingMigrations;
}
@Override
public boolean isIgnoreIgnoredMigrations() {
return ignoreIgnoredMigrations;
}
@Override
public boolean isIgnorePendingMigrations() {
return ignorePendingMigrations;
}
@Override
public boolean isIgnoreFutureMigrations() {
return ignoreFutureMigrations;
}
@Override
public boolean isValidateMigrationNaming() {
return validateMigrationNaming;
}
@Override
public boolean isValidateOnMigrate() {
return validateOnMigrate;
}
@Override
public boolean isCleanOnValidationError() {
return cleanOnValidationError;
}
@Override
public boolean isCleanDisabled() {
return cleanDisabled;
}
@Override
public MigrationVersion getBaselineVersion() {
return baselineVersion;
}
@Override
public String getBaselineDescription() {
return baselineDescription;
}
@Override
public boolean isBaselineOnMigrate() {
return baselineOnMigrate;
}
@Override
public boolean isOutOfOrder() {
return outOfOrder;
}
@Override
public MigrationResolver[] getResolvers() {
return resolvers;
}
@Override
public boolean isSkipDefaultResolvers() {
return skipDefaultResolvers;
}
@Override
public DataSource getDataSource() {
if (dataSource == null &&
(StringUtils.hasLength(driver) || StringUtils.hasLength(user) || StringUtils.hasLength(password))) {
LOG.warn("Discarding INCOMPLETE dataSource configuration! " + ConfigUtils.URL + " must be set.");
}
return dataSource;
}
@Override
public int getConnectRetries() {
return connectRetries;
}
@Override
public String getInitSql() {
return initSql;
}
@Override
public ClassLoader getClassLoader() {
return classLoader;
}
@Override
public boolean isMixed() {
return mixed;
}
@Override
public String getInstalledBy() {
return installedBy;
}
@Override
public boolean isGroup() {
return group;
}
@Override
public String[] getErrorOverrides() {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("errorOverrides");
}
@Override
public OutputStream getDryRunOutput() {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("dryRunOutput");
}
@Override
public String getLicenseKey() {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("licenseKey");
}
Whether Flyway should output a table with the results of queries when executing migrations.
Flyway Pro and Flyway Enterprise only
Returns: true
to output the results table (default: true
)
/**
* Whether Flyway should output a table with the results of queries when executing migrations.
*
* <p><i>Flyway Pro and Flyway Enterprise only</i></p>
*
* @return {@code true} to output the results table (default: {@code true})
*/
@Override
public boolean outputQueryResults() {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("outputQueryResults");
}
Sets the stream where to output the SQL statements of a migration dry run. null
to execute the SQL statements directly against the database. The stream when be closing when Flyway finishes writing the output. Flyway Pro and Flyway Enterprise only
Params: - dryRunOutput – The output file or
null
to execute the SQL statements directly against the database.
/**
* Sets the stream where to output the SQL statements of a migration dry run. {@code null} to execute the SQL statements
* directly against the database. The stream when be closing when Flyway finishes writing the output.
* <p><i>Flyway Pro and Flyway Enterprise only</i></p>
*
* @param dryRunOutput The output file or {@code null} to execute the SQL statements directly against the database.
*/
public void setDryRunOutput(OutputStream dryRunOutput) {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("dryRunOutput");
}
Sets the file where to output the SQL statements of a migration dry run. null
to execute the SQL statements directly against the database. If the file specified is in a non-existent directory, Flyway will create all directories and parent directories as needed. Flyway Pro and Flyway Enterprise only
Params: - dryRunOutput – The output file or
null
to execute the SQL statements directly against the database.
/**
* Sets the file where to output the SQL statements of a migration dry run. {@code null} to execute the SQL statements
* directly against the database. If the file specified is in a non-existent directory, Flyway will create all
* directories and parent directories as needed.
* <p><i>Flyway Pro and Flyway Enterprise only</i></p>
*
* @param dryRunOutput The output file or {@code null} to execute the SQL statements directly against the database.
*/
public void setDryRunOutputAsFile(File dryRunOutput) {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("dryRunOutput");
}
Sets the file where to output the SQL statements of a migration dry run. null
to execute the SQL statements directly against the database. If the file specified is in a non-existent directory, Flyway will create all directories and parent directories as needed. Flyway Pro and Flyway Enterprise only
Params: - dryRunOutputFileName – The name of the output file or
null
to execute the SQL statements directly against the database.
/**
* Sets the file where to output the SQL statements of a migration dry run. {@code null} to execute the SQL statements
* directly against the database. If the file specified is in a non-existent directory, Flyway will create all
* directories and parent directories as needed.
* <p><i>Flyway Pro and Flyway Enterprise only</i></p>
*
* @param dryRunOutputFileName The name of the output file or {@code null} to execute the SQL statements directly
* against the database.
*/
public void setDryRunOutputAsFileName(String dryRunOutputFileName) {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("dryRunOutput");
}
Rules for the built-in error handler that let you override specific SQL states and errors codes in order to force
specific errors or warnings to be treated as debug messages, info messages, warnings or errors.
Each error override has the following format: STATE:12345:W
. It is a 5 character SQL state (or * to match all SQL states), a colon, the SQL error code (or * to match all SQL error codes), a colon and finally the desired behavior that should override the initial one.
The following behaviors are accepted:
D
to force a debug message
D-
to force a debug message, but do not show the original sql state and error code
I
to force an info message
I-
to force an info message, but do not show the original sql state and error code
W
to force a warning
W-
to force a warning, but do not show the original sql state and error code
E
to force an error
E-
to force an error, but do not show the original sql state and error code
Example 1: to force Oracle stored procedure compilation issues to produce errors instead of warnings, the following errorOverride can be used: 99999:17110:E
Example 2: to force SQL Server PRINT messages to be displayed as info messages (without SQL state and error code details) instead of warnings, the following errorOverride can be used: S0001:0:I-
Example 3: to force all errors with SQL error code 123 to be treated as warnings instead, the following errorOverride can be used: *:123:W
Flyway Pro and Flyway Enterprise only
Params: - errorOverrides – The ErrorOverrides or an empty array if none are defined. (default: none)
/**
* Rules for the built-in error handler that let you override specific SQL states and errors codes in order to force
* specific errors or warnings to be treated as debug messages, info messages, warnings or errors.
* <p>Each error override has the following format: {@code STATE:12345:W}.
* It is a 5 character SQL state (or * to match all SQL states), a colon,
* the SQL error code (or * to match all SQL error codes), a colon and finally
* the desired behavior that should override the initial one.</p>
* <p>The following behaviors are accepted:</p>
* <ul>
* <li>{@code D} to force a debug message</li>
* <li>{@code D-} to force a debug message, but do not show the original sql state and error code</li>
* <li>{@code I} to force an info message</li>
* <li>{@code I-} to force an info message, but do not show the original sql state and error code</li>
* <li>{@code W} to force a warning</li>
* <li>{@code W-} to force a warning, but do not show the original sql state and error code</li>
* <li>{@code E} to force an error</li>
* <li>{@code E-} to force an error, but do not show the original sql state and error code</li>
* </ul>
* <p>Example 1: to force Oracle stored procedure compilation issues to produce
* errors instead of warnings, the following errorOverride can be used: {@code 99999:17110:E}</p>
* <p>Example 2: to force SQL Server PRINT messages to be displayed as info messages (without SQL state and error
* code details) instead of warnings, the following errorOverride can be used: {@code S0001:0:I-}</p>
* <p>Example 3: to force all errors with SQL error code 123 to be treated as warnings instead,
* the following errorOverride can be used: {@code *:123:W}</p>
* <p><i>Flyway Pro and Flyway Enterprise only</i></p>
*
* @param errorOverrides The ErrorOverrides or an empty array if none are defined. (default: none)
*/
public void setErrorOverrides(String... errorOverrides) {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("errorOverrides");
}
Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).
Params: - group –
true
if migrations should be grouped. false
if they should be applied individually instead. (default: false
)
/**
* Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).
*
* @param group {@code true} if migrations should be grouped. {@code false} if they should be applied individually instead. (default: {@code false})
*/
public void setGroup(boolean group) {
this.group = group;
}
The username that will be recorded in the schema history table as having applied the migration.
Params: - installedBy – The username or
null
for the current database user of the connection. (default: null
).
/**
* The username that will be recorded in the schema history table as having applied the migration.
*
* @param installedBy The username or {@code null} for the current database user of the connection. (default: {@code null}).
*/
public void setInstalledBy(String installedBy) {
if ("".equals(installedBy)) {
installedBy = null;
}
this.installedBy = installedBy;
}
Whether to allow mixing transactional and non-transactional statements within the same migration. Enabling this
automatically causes the entire affected migration to be run without a transaction.
Note that this is only applicable for PostgreSQL, Aurora PostgreSQL, SQL Server and SQLite which all have
statements that do not run at all within a transaction.
This is not to be confused with implicit transaction, as they occur in MySQL or Oracle, where even though a
DDL statement was run within a transaction, the database will issue an implicit commit before and after
its execution.
Params: - mixed –
true
if mixed migrations should be allowed. false
if an error should be thrown instead. (default: false
)
/**
* Whether to allow mixing transactional and non-transactional statements within the same migration. Enabling this
* automatically causes the entire affected migration to be run without a transaction.
*
* <p>Note that this is only applicable for PostgreSQL, Aurora PostgreSQL, SQL Server and SQLite which all have
* statements that do not run at all within a transaction.</p>
* <p>This is not to be confused with implicit transaction, as they occur in MySQL or Oracle, where even though a
* DDL statement was run within a transaction, the database will issue an implicit commit before and after
* its execution.</p>
*
* @param mixed {@code true} if mixed migrations should be allowed. {@code false} if an error should be thrown instead. (default: {@code false})
*/
public void setMixed(boolean mixed) {
this.mixed = mixed;
}
Ignore missing migrations when reading the schema history 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 schema history 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.
Note that if the most recently applied migration is removed, Flyway has no way to know it is missing and will
mark it as future instead.
Params: - ignoreMissingMigrations –
true
to continue normally and log a warning, false
to fail fast with an exception. (default: false
)
/**
* Ignore missing migrations when reading the schema history 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 schema history 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.
* Note that if the most recently applied migration is removed, Flyway has no way to know it is missing and will
* mark it as future instead.
*
* @param ignoreMissingMigrations {@code true} to continue normally and log a warning, {@code false} to fail fast with an exception.
* (default: {@code false})
*/
public void setIgnoreMissingMigrations(boolean ignoreMissingMigrations) {
this.ignoreMissingMigrations = ignoreMissingMigrations;
}
Ignore ignored migrations when reading the schema history table. These are migrations that were added in between
already migrated migrations in this version. For example: we have migrations available on the classpath with
versions from 1.0 to 3.0. The schema history table indicates that version 1 was finished on 1.0.15, and the next
one was 2.0.0. But with the next release a new migration was added to version 1: 1.0.16. Such scenario is ignored
by migrate command, but by default is rejected by validate. When ignoreIgnoredMigrations is enabled, such case
will not be reported by validate command. This is useful for situations where one must be able to deliver
complete set of migrations in a delivery package for multiple versions of the product, and allows for further
development of older versions.
Params: - ignoreIgnoredMigrations –
true
to continue normally, false
to fail fast with an exception. (default: false
)
/**
* Ignore ignored migrations when reading the schema history table. These are migrations that were added in between
* already migrated migrations in this version. For example: we have migrations available on the classpath with
* versions from 1.0 to 3.0. The schema history table indicates that version 1 was finished on 1.0.15, and the next
* one was 2.0.0. But with the next release a new migration was added to version 1: 1.0.16. Such scenario is ignored
* by migrate command, but by default is rejected by validate. When ignoreIgnoredMigrations is enabled, such case
* will not be reported by validate command. This is useful for situations where one must be able to deliver
* complete set of migrations in a delivery package for multiple versions of the product, and allows for further
* development of older versions.
*
* @param ignoreIgnoredMigrations {@code true} to continue normally, {@code false} to fail fast with an exception.
* (default: {@code false})
*/
public void setIgnoreIgnoredMigrations(boolean ignoreIgnoredMigrations) {
this.ignoreIgnoredMigrations = ignoreIgnoredMigrations;
}
Ignore pending migrations when reading the schema history table. These are migrations that are available
but have not yet been applied. This can be useful for verifying that in-development migration changes
don't contain any validation-breaking changes of migrations that have already been applied to a production
environment, e.g. as part of a CI/CD process, without failing because of the existence of new migration versions.
Params: - ignorePendingMigrations –
true
to continue normally, false
to fail fast with an exception. (default: false
)
/**
* Ignore pending migrations when reading the schema history table. These are migrations that are available
* but have not yet been applied. This can be useful for verifying that in-development migration changes
* don't contain any validation-breaking changes of migrations that have already been applied to a production
* environment, e.g. as part of a CI/CD process, without failing because of the existence of new migration versions.
*
* @param ignorePendingMigrations {@code true} to continue normally, {@code false} to fail fast with an exception.
* (default: {@code false})
*/
public void setIgnorePendingMigrations(boolean ignorePendingMigrations) {
this.ignorePendingMigrations = ignorePendingMigrations;
}
Whether to ignore future migrations when reading the schema history 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 schema history 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.
Params: - ignoreFutureMigrations –
true
to continue normally and log a warning, false
to fail fast with an exception. (default: true
)
/**
* Whether to ignore future migrations when reading the schema history 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 schema history 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.
*
* @param ignoreFutureMigrations {@code true} to continue normally and log a warning, {@code false} to fail
* fast with an exception. (default: {@code true})
*/
public void setIgnoreFutureMigrations(boolean ignoreFutureMigrations) {
this.ignoreFutureMigrations = ignoreFutureMigrations;
}
Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention. A failure can be
useful to check that errors such as case sensitivity in migration prefixes have been corrected.
Params: - validateMigrationNaming –
false
to continue normally, true
to fail fast with an exception. (default: false
)
/**
* Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention. A failure can be
* useful to check that errors such as case sensitivity in migration prefixes have been corrected.
*
* @param validateMigrationNaming {@code false} to continue normally, {@code true} to fail
* fast with an exception. (default: {@code false})
*/
public void setValidateMigrationNaming(boolean validateMigrationNaming) {
this.validateMigrationNaming = validateMigrationNaming;
}
Whether to automatically call validate or not when running migrate.
Params: - validateOnMigrate –
true
if validate should be called. false
if not. (default: true
)
/**
* Whether to automatically call validate or not when running migrate.
*
* @param validateOnMigrate {@code true} if validate should be called. {@code false} if not. (default: {@code true})
*/
public void setValidateOnMigrate(boolean validateOnMigrate) {
this.validateOnMigrate = validateOnMigrate;
}
Whether to automatically call clean or not when a validation error occurs.
This is exclusively intended as a convenience for development. even though we
strongly recommend not to change migration scripts once they have been checked into SCM and run, this provides a
way of dealing with this case in a smooth manner. The database will be wiped clean automatically, ensuring that
the next migration will bring you back to the state checked into SCM.
Warning ! Do not enable in production !
Params: - cleanOnValidationError –
true
if clean should be called. false
if not. (default: false
)
/**
* Whether to automatically call clean or not when a validation error occurs.
* <p> This is exclusively intended as a convenience for development. even though we
* strongly recommend not to change migration scripts once they have been checked into SCM and run, this provides a
* way of dealing with this case in a smooth manner. The database will be wiped clean automatically, ensuring that
* the next migration will bring you back to the state checked into SCM.</p>
* <p><b>Warning ! Do not enable in production !</b></p>
*
* @param cleanOnValidationError {@code true} if clean should be called. {@code false} if not. (default: {@code false})
*/
public void setCleanOnValidationError(boolean cleanOnValidationError) {
this.cleanOnValidationError = cleanOnValidationError;
}
Whether to disable clean.
This is especially useful for production environments where running clean can be quite a career limiting move.
Params: - cleanDisabled –
true
to disable clean. false
to leave it enabled. (default: false
)
/**
* Whether to disable clean.
* <p>This is especially useful for production environments where running clean can be quite a career limiting move.</p>
*
* @param cleanDisabled {@code true} to disable clean. {@code false} to leave it enabled. (default: {@code false})
*/
public void setCleanDisabled(boolean cleanDisabled) {
this.cleanDisabled = cleanDisabled;
}
Sets the locations to scan recursively for migrations.
The location type is determined by its prefix. 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, may only contain SQL migrations and are only scanned recursively down non-hidden directories.
Params: - locations – Locations to scan recursively for migrations. (default: db/migration)
/**
* Sets the locations to scan recursively for migrations.
* <p>The location type is determined by its prefix.
* Unprefixed locations or locations starting with {@code classpath:} point to a package on the classpath and may
* contain both SQL and Java-based migrations.
* Locations starting with {@code filesystem:} point to a directory on the filesystem, may only
* contain SQL migrations and are only scanned recursively down non-hidden directories.</p>
*
* @param locations Locations to scan recursively for migrations. (default: db/migration)
*/
public void setLocationsAsStrings(String... locations) {
this.locations = new Locations(locations);
}
Sets the locations to scan recursively for migrations.
The location type is determined by its prefix. 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, may only contain SQL migrations and are only scanned recursively down non-hidden directories.
Params: - locations – Locations to scan recursively for migrations. (default: db/migration)
/**
* Sets the locations to scan recursively for migrations.
* <p>The location type is determined by its prefix.
* Unprefixed locations or locations starting with {@code classpath:} point to a package on the classpath and may
* contain both SQL and Java-based migrations.
* Locations starting with {@code filesystem:} point to a directory on the filesystem, may only
* contain SQL migrations and are only scanned recursively down non-hidden directories.</p>
*
* @param locations Locations to scan recursively for migrations. (default: db/migration)
*/
public void setLocations(Location... locations) {
this.locations = new Locations(Arrays.asList(locations));
}
Sets the encoding of Sql migrations.
Params: - encoding – The encoding of Sql migrations. (default: UTF-8)
/**
* Sets the encoding of Sql migrations.
*
* @param encoding The encoding of Sql migrations. (default: UTF-8)
*/
public void setEncoding(Charset encoding) {
this.encoding = encoding;
}
Sets the encoding of Sql migrations.
Params: - encoding – The encoding of Sql migrations. (default: UTF-8)
/**
* Sets the encoding of Sql migrations.
*
* @param encoding The encoding of Sql migrations. (default: UTF-8)
*/
public void setEncodingAsString(String encoding) {
this.encoding = Charset.forName(encoding);
}
Sets the default schema managed by Flyway. This schema name is case-sensitive. If not specified, but
Schemas is, Flyway uses the first schema in that list. If that is also not specified, Flyway uses the default
schema for the database connection.
Consequences:
- This schema will be the one containing the schema history table.
- This schema will be the default for the database connection (provided the database supports this concept).
Params: - schema – The default schema managed by Flyway.
/**
* Sets the default schema managed by Flyway. This schema name is case-sensitive. If not specified, but
* <i>Schemas</i> is, Flyway uses the first schema in that list. If that is also not specified, Flyway uses the default
* schema for the database connection.
* <p>Consequences:</p>
* <ul>
* <li>This schema will be the one containing the schema history table.</li>
* <li>This schema will be the default for the database connection (provided the database supports this concept).</li>
* </ul>
*
* @param schema The default schema managed by Flyway.
*/
public void setDefaultSchema(String schema) {
this.defaultSchemaName = schema;
}
Sets the schemas managed by Flyway. These schema names are case-sensitive. If not specified, Flyway uses
the default schema for the database connection. If defaultSchema is not specified, then the first of
this list also acts as default schema.
Consequences:
- Flyway will automatically attempt to create all these schemas, unless they already exist.
- The schemas will be cleaned in the order of this list.
- If Flyway created them, the schemas themselves will be dropped when cleaning.
Params: - schemas – The schemas managed by Flyway. May not be
null
. Must contain at least one element.
/**
* Sets the schemas managed by Flyway. These schema names are case-sensitive. If not specified, Flyway uses
* the default schema for the database connection. If <i>defaultSchema</i> is not specified, then the first of
* this list also acts as default schema.
* <p>Consequences:</p>
* <ul>
* <li>Flyway will automatically attempt to create all these schemas, unless they already exist.</li>
* <li>The schemas will be cleaned in the order of this list.</li>
* <li>If Flyway created them, the schemas themselves will be dropped when cleaning.</li>
* </ul>
*
* @param schemas The schemas managed by Flyway. May not be {@code null}. Must contain at least one element.
*/
public void setSchemas(String... schemas) {
this.schemaNames = schemas;
}
Sets the name of the schema history table that will be used by Flyway.
By default (single-schema mode)
the schema history table is placed in the default schema for the connection provided by the datasource.
When
the flyway.schemas property is set (multi-schema mode), the schema history table is placed in the first schema
of the list.
Params: - table – The name of the schema history table that will be used by Flyway. (default: flyway_schema_history)
/**
* <p>Sets the name of the schema history table that will be used by Flyway. </p><p> By default (single-schema mode)
* the schema history table is placed in the default schema for the connection provided by the datasource. </p> <p> When
* the <i>flyway.schemas</i> property is set (multi-schema mode), the schema history table is placed in the first schema
* of the list. </p>
*
* @param table The name of the schema history table that will be used by Flyway. (default: flyway_schema_history)
*/
public void setTable(String table) {
this.table = table;
}
Sets the tablespace where to create the schema history table that will be used by Flyway.
If not specified, Flyway uses the default tablespace for the database connection.This setting is only relevant
for databases that do support the notion of tablespaces. Its value is simply
ignored for all others.
Params: - tablespace – The tablespace where to create the schema history table that will be used by Flyway.
/**
* <p>Sets the tablespace where to create the schema history table that will be used by Flyway.</p>
* <p>If not specified, Flyway uses the default tablespace for the database connection.This setting is only relevant
* for databases that do support the notion of tablespaces. Its value is simply
* ignored for all others.</p>
*
* @param tablespace The tablespace where to create the schema history table that will be used by Flyway.
*/
public void setTablespace(String tablespace) {
this.tablespace = tablespace;
}
Sets the target version up to which Flyway should consider migrations.
Migrations with a higher version number will be ignored.
Special values:
current
: designates the current version of the schema
latest
: the latest version of the schema, as defined by the migration with the highest version
Defaults to latest
. /**
* Sets the target version up to which Flyway should consider migrations.
* Migrations with a higher version number will be ignored.
* Special values:
* <ul>
* <li>{@code current}: designates the current version of the schema</li>
* <li>{@code latest}: the latest version of the schema, as defined by the migration with the highest version</li>
* </ul>
* Defaults to {@code latest}.
*/
public void setTarget(MigrationVersion target) {
this.target = target;
}
Sets the target version up to which Flyway should consider migrations.
Migrations with a higher version number will be ignored.
Special values:
current
: designates the current version of the schema
latest
: the latest version of the schema, as defined by the migration with the highest version
Defaults to latest
. /**
* Sets the target version up to which Flyway should consider migrations.
* Migrations with a higher version number will be ignored.
* Special values:
* <ul>
* <li>{@code current}: designates the current version of the schema</li>
* <li>{@code latest}: the latest version of the schema, as defined by the migration with the highest version</li>
* </ul>
* Defaults to {@code latest}.
*/
public void setTargetAsString(String target) {
this.target = MigrationVersion.fromVersion(target);
}
Sets whether placeholders should be replaced.
Params: - placeholderReplacement – Whether placeholders should be replaced. (default: true)
/**
* Sets whether placeholders should be replaced.
*
* @param placeholderReplacement Whether placeholders should be replaced. (default: true)
*/
public void setPlaceholderReplacement(boolean placeholderReplacement) {
this.placeholderReplacement = placeholderReplacement;
}
Sets the placeholders to replace in sql migration scripts.
Params: - placeholders – The map of <placeholder, replacementValue> to apply to sql migration scripts.
/**
* Sets the placeholders to replace in sql migration scripts.
*
* @param placeholders The map of <placeholder, replacementValue> to apply to sql migration scripts.
*/
public void setPlaceholders(Map<String, String> placeholders) {
this.placeholders = placeholders;
}
Sets the prefix of every placeholder.
Params: - placeholderPrefix – The prefix of every placeholder. (default: ${ )
/**
* Sets the prefix of every placeholder.
*
* @param placeholderPrefix The prefix of every placeholder. (default: ${ )
*/
public void setPlaceholderPrefix(String placeholderPrefix) {
if (!StringUtils.hasLength(placeholderPrefix)) {
throw new FlywayException("placeholderPrefix cannot be empty!", ErrorCode.CONFIGURATION);
}
this.placeholderPrefix = placeholderPrefix;
}
Sets the suffix of every placeholder.
Params: - placeholderSuffix – The suffix of every placeholder. (default: } )
/**
* Sets the suffix of every placeholder.
*
* @param placeholderSuffix The suffix of every placeholder. (default: } )
*/
public void setPlaceholderSuffix(String placeholderSuffix) {
if (!StringUtils.hasLength(placeholderSuffix)) {
throw new FlywayException("placeholderSuffix cannot be empty!", ErrorCode.CONFIGURATION);
}
this.placeholderSuffix = placeholderSuffix;
}
Sets 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
Params: - sqlMigrationPrefix – The file name prefix for sql migrations (default: V)
/**
* Sets the file name prefix for sql migrations.
* <p>Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
* which using the defaults translates to V1_1__My_description.sql</p>
*
* @param sqlMigrationPrefix The file name prefix for sql migrations (default: V)
*/
public void setSqlMigrationPrefix(String sqlMigrationPrefix) {
this.sqlMigrationPrefix = sqlMigrationPrefix;
}
@Override
public String getUndoSqlMigrationPrefix() {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("undoSqlMigrationPrefix");
}
Sets the file name prefix for undo SQL migrations. (default: U)
Undo SQL migrations are responsible for undoing the effects of the versioned migration with the same version.
They have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
which using the defaults translates to U1.1__My_description.sql
Flyway Pro and Flyway Enterprise only
Params: - undoSqlMigrationPrefix – The file name prefix for undo SQL migrations. (default: U)
/**
* Sets the file name prefix for undo SQL migrations. (default: U)
* <p>Undo SQL migrations are responsible for undoing the effects of the versioned migration with the same version.</p>
* <p>They have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
* which using the defaults translates to U1.1__My_description.sql</p>
* <p><i>Flyway Pro and Flyway Enterprise only</i></p>
*
* @param undoSqlMigrationPrefix The file name prefix for undo SQL migrations. (default: U)
*/
public void setUndoSqlMigrationPrefix(String undoSqlMigrationPrefix) {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("undoSqlMigrationPrefix");
}
The manually added Java-based migrations. These are not Java-based migrations discovered through classpath
scanning and instantiated by Flyway. Instead these are manually added instances of JavaMigration.
This is particularly useful when working with a dependency injection container, where you may want the DI
container to instantiate the class and wire up its dependencies for you.
Params: - javaMigrations – The manually added Java-based migrations. An empty array if none. (default: none)
/**
* The manually added Java-based migrations. These are not Java-based migrations discovered through classpath
* scanning and instantiated by Flyway. Instead these are manually added instances of JavaMigration.
* This is particularly useful when working with a dependency injection container, where you may want the DI
* container to instantiate the class and wire up its dependencies for you.
*
* @param javaMigrations The manually added Java-based migrations. An empty array if none. (default: none)
*/
public void setJavaMigrations(JavaMigration... javaMigrations) {
if (javaMigrations == null) {
throw new FlywayException("javaMigrations cannot be null", ErrorCode.CONFIGURATION);
}
this.javaMigrations = javaMigrations;
}
@Override
public boolean isStream() {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("stream");
}
Whether to stream SQL migrations when executing them. Streaming doesn't load the entire migration in memory at
once. Instead each statement is loaded individually. This is particularly useful for very large SQL migrations
composed of multiple MB or even GB of reference data, as this dramatically reduces Flyway's memory consumption.
Flyway Pro and Flyway Enterprise only
Params: - stream –
true
to stream SQL migrations. false
to fully loaded them in memory instead. (default: false
)
/**
* Whether to stream SQL migrations when executing them. Streaming doesn't load the entire migration in memory at
* once. Instead each statement is loaded individually. This is particularly useful for very large SQL migrations
* composed of multiple MB or even GB of reference data, as this dramatically reduces Flyway's memory consumption.
* <p><i>Flyway Pro and Flyway Enterprise only</i></p>
*
* @param stream {@code true} to stream SQL migrations. {@code false} to fully loaded them in memory instead. (default: {@code false})
*/
public void setStream(boolean stream) {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("stream");
}
@Override
public boolean isBatch() {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("batch");
}
Whether to batch SQL statements when executing them. Batching can save up to 99 percent of network roundtrips by
sending up to 100 statements at once over the network to the database, instead of sending each statement
individually. This is particularly useful for very large SQL migrations composed of multiple MB or even GB of
reference data, as this can dramatically reduce the network overhead. This is supported for INSERT, UPDATE,
DELETE, MERGE and UPSERT statements. All other statements are automatically executed without batching.
Flyway Pro and Flyway Enterprise only
Params: - batch –
true
to batch SQL statements. false
to execute them individually instead. (default: false
)
/**
* Whether to batch SQL statements when executing them. Batching can save up to 99 percent of network roundtrips by
* sending up to 100 statements at once over the network to the database, instead of sending each statement
* individually. This is particularly useful for very large SQL migrations composed of multiple MB or even GB of
* reference data, as this can dramatically reduce the network overhead. This is supported for INSERT, UPDATE,
* DELETE, MERGE and UPSERT statements. All other statements are automatically executed without batching.
* <p><i>Flyway Pro and Flyway Enterprise only</i></p>
*
* @param batch {@code true} to batch SQL statements. {@code false} to execute them individually instead. (default: {@code false})
*/
public void setBatch(boolean batch) {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("batch");
}
Sets the file name prefix for repeatable sql migrations.
Repeatable sql migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix ,
which using the defaults translates to R__My_description.sql
Params: - repeatableSqlMigrationPrefix – The file name prefix for repeatable sql migrations (default: R)
/**
* Sets the file name prefix for repeatable sql migrations.
* <p>Repeatable sql migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix ,
* which using the defaults translates to R__My_description.sql</p>
*
* @param repeatableSqlMigrationPrefix The file name prefix for repeatable sql migrations (default: R)
*/
public void setRepeatableSqlMigrationPrefix(String repeatableSqlMigrationPrefix) {
this.repeatableSqlMigrationPrefix = repeatableSqlMigrationPrefix;
}
Sets the file name separator for sql migrations.
Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
which using the defaults translates to V1_1__My_description.sql
Params: - sqlMigrationSeparator – The file name separator for sql migrations (default: __)
/**
* Sets the file name separator for sql migrations.
* <p>Sql migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
* which using the defaults translates to V1_1__My_description.sql</p>
*
* @param sqlMigrationSeparator The file name separator for sql migrations (default: __)
*/
public void setSqlMigrationSeparator(String sqlMigrationSeparator) {
if (!StringUtils.hasLength(sqlMigrationSeparator)) {
throw new FlywayException("sqlMigrationSeparator cannot be empty!", ErrorCode.CONFIGURATION);
}
this.sqlMigrationSeparator = sqlMigrationSeparator;
}
The file name suffixes for SQL migrations. (default: .sql)
SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
which using the defaults translates to V1_1__My_description.sql
Multiple suffixes (like .sql,.pkg,.pkb) can be specified for easier compatibility with other tools such as
editors with specific file associations.
Params: - sqlMigrationSuffixes – The file name suffixes for SQL migrations.
/**
* The file name suffixes for SQL migrations. (default: .sql)
* <p>SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix ,
* which using the defaults translates to V1_1__My_description.sql</p>
* <p>Multiple suffixes (like .sql,.pkg,.pkb) can be specified for easier compatibility with other tools such as
* editors with specific file associations.</p>
*
* @param sqlMigrationSuffixes The file name suffixes for SQL migrations.
*/
public void setSqlMigrationSuffixes(String... sqlMigrationSuffixes) {
this.sqlMigrationSuffixes = sqlMigrationSuffixes;
}
Sets the datasource to use. Must have the necessary privileges to execute ddl.
Params: - dataSource – The datasource to use. Must have the necessary privileges to execute ddl.
/**
* Sets the datasource to use. Must have the necessary privileges to execute ddl.
*
* @param dataSource The datasource to use. Must have the necessary privileges to execute ddl.
*/
public void setDataSource(DataSource dataSource) {
driver = null;
url = null;
user = null;
password = null;
this.dataSource = dataSource;
}
Sets the datasource to use. Must have the necessary privileges to execute ddl.
To use a custom ClassLoader, setClassLoader() must be called prior to calling this method.
Params: - url – The JDBC URL of the database.
- user – The user of the database.
- password – The password of the database.
/**
* Sets the datasource to use. Must have the necessary privileges to execute ddl.
* <p>To use a custom ClassLoader, setClassLoader() must be called prior to calling this method.</p>
*
* @param url The JDBC URL of the database.
* @param user The user of the database.
* @param password The password of the database.
*/
public void setDataSource(String url, String user, String password) {
this.dataSource = new DriverDataSource(classLoader, null, url, user, password);
}
The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will
wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries.
Params: - connectRetries – The maximum number of retries (default: 0).
/**
* The maximum number of retries when attempting to connect to the database. After each failed attempt, Flyway will
* wait 1 second before attempting to connect again, up to the maximum number of times specified by connectRetries.
*
* @param connectRetries The maximum number of retries (default: 0).
*/
public void setConnectRetries(int connectRetries) {
if (connectRetries < 0) {
throw new FlywayException("Invalid number of connectRetries (must be 0 or greater): " + connectRetries, ErrorCode.CONFIGURATION);
}
this.connectRetries = connectRetries;
}
The SQL statements to run to initialize a new database connection immediately after opening it.
Params: - initSql – The SQL statements. (default:
null
)
/**
* The SQL statements to run to initialize a new database connection immediately after opening it.
*
* @param initSql The SQL statements. (default: {@code null})
*/
public void setInitSql(String initSql) {
this.initSql = initSql;
}
Sets the version to tag an existing schema with when executing baseline.
Params: - baselineVersion – The version to tag an existing schema with when executing baseline. (default: 1)
/**
* Sets the version to tag an existing schema with when executing baseline.
*
* @param baselineVersion The version to tag an existing schema with when executing baseline. (default: 1)
*/
public void setBaselineVersion(MigrationVersion baselineVersion) {
this.baselineVersion = baselineVersion;
}
Sets the version to tag an existing schema with when executing baseline.
Params: - baselineVersion – The version to tag an existing schema with when executing baseline. (default: 1)
/**
* Sets the version to tag an existing schema with when executing baseline.
*
* @param baselineVersion The version to tag an existing schema with when executing baseline. (default: 1)
*/
public void setBaselineVersionAsString(String baselineVersion) {
this.baselineVersion = MigrationVersion.fromVersion(baselineVersion);
}
Sets the description to tag an existing schema with when executing baseline.
Params: - baselineDescription – The description to tag an existing schema with when executing baseline. (default: << Flyway Baseline >>)
/**
* Sets the description to tag an existing schema with when executing baseline.
*
* @param baselineDescription The description to tag an existing schema with when executing baseline. (default: << Flyway Baseline >>)
*/
public void setBaselineDescription(String baselineDescription) {
this.baselineDescription = baselineDescription;
}
Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history 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!
Params: - baselineOnMigrate –
true
if baseline should be called on migrate for non-empty schemas, false
if not. (default: false
)
/**
* <p>
* Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table.
* This schema will then be baselined with the {@code baselineVersion} before executing the migrations.
* Only migrations above {@code baselineVersion} will then be applied.
* </p>
* <p>
* This is useful for initial Flyway production deployments on projects with an existing DB.
* </p>
* <p>
* 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!
* </p>
*
* @param baselineOnMigrate {@code true} if baseline should be called on migrate for non-empty schemas, {@code false} if not. (default: {@code false})
*/
public void setBaselineOnMigrate(boolean baselineOnMigrate) {
this.baselineOnMigrate = baselineOnMigrate;
}
Allows migrations to be run "out of order".
If you already have versions 1 and 3 applied, and now a version 2 is found,
it will be applied too instead of being ignored.
Params: - outOfOrder –
true
if outOfOrder migrations should be applied, false
if not. (default: false
)
/**
* Allows migrations to be run "out of order".
* <p>If you already have versions 1 and 3 applied, and now a version 2 is found,
* it will be applied too instead of being ignored.</p>
*
* @param outOfOrder {@code true} if outOfOrder migrations should be applied, {@code false} if not. (default: {@code false})
*/
public void setOutOfOrder(boolean outOfOrder) {
this.outOfOrder = outOfOrder;
}
Gets the callbacks for lifecycle notifications.
Returns: The callbacks for lifecycle notifications. An empty array if none. (default: none)
/**
* Gets the callbacks for lifecycle notifications.
*
* @return The callbacks for lifecycle notifications. An empty array if none. (default: none)
*/
@Override
public Callback[] getCallbacks() {
return callbacks.toArray(new Callback[0]);
}
@Override
public boolean isSkipDefaultCallbacks() {
return skipDefaultCallbacks;
}
Set the callbacks for lifecycle notifications.
Params: - callbacks – The callbacks for lifecycle notifications. (default: none)
/**
* Set the callbacks for lifecycle notifications.
*
* @param callbacks The callbacks for lifecycle notifications. (default: none)
*/
public void setCallbacks(Callback... callbacks) {
this.callbacks.clear();
this.callbacks.addAll(Arrays.asList(callbacks));
}
Set the callbacks for lifecycle notifications.
Params: - callbacks – The fully qualified class names of the callbacks for lifecycle notifications. (default: none)
/**
* Set the callbacks for lifecycle notifications.
*
* @param callbacks The fully qualified class names of the callbacks for lifecycle notifications. (default: none)
*/
public void setCallbacksAsClassNames(String... callbacks) {
this.callbacks.clear();
for (String callback : callbacks) {
Object o = ClassUtils.instantiate(callback, classLoader);
if (o instanceof Callback) {
this.callbacks.add((Callback) o);
} else {
throw new FlywayException("Invalid callback: " + callback + " (must implement org.flywaydb.core.api.callback.Callback)", ErrorCode.CONFIGURATION);
}
}
}
Whether Flyway should skip the default callbacks. If true, only custom callbacks are used.
Params: - skipDefaultCallbacks – Whether default built-in callbacks should be skipped.
(default: false)
/**
* Whether Flyway should skip the default callbacks. If true, only custom callbacks are used.
*
* @param skipDefaultCallbacks Whether default built-in callbacks should be skipped. <p>(default: false)</p>
*/
public void setSkipDefaultCallbacks(boolean skipDefaultCallbacks) {
this.skipDefaultCallbacks = skipDefaultCallbacks;
}
Sets custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
Params: - resolvers – The custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply. (default: empty list)
/**
* Sets custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
*
* @param resolvers The custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply. (default: empty list)
*/
public void setResolvers(MigrationResolver... resolvers) {
this.resolvers = resolvers;
}
Sets custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
Params: - resolvers – The fully qualified class names of the custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply. (default: empty list)
/**
* Sets custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply.
*
* @param resolvers The fully qualified class names of the custom MigrationResolvers to be used in addition to the built-in ones for resolving Migrations to apply. (default: empty list)
*/
public void setResolversAsClassNames(String... resolvers) {
List<MigrationResolver> resolverList = ClassUtils.instantiateAll(resolvers, classLoader);
setResolvers(resolverList.toArray(new MigrationResolver[resolvers.length]));
}
Whether Flyway should skip the default resolvers. If true, only custom resolvers are used.
Params: - skipDefaultResolvers – Whether default built-in resolvers should be skipped.
(default: false)
/**
* Whether Flyway should skip the default resolvers. If true, only custom resolvers are used.
*
* @param skipDefaultResolvers Whether default built-in resolvers should be skipped. <p>(default: false)</p>
*/
public void setSkipDefaultResolvers(boolean skipDefaultResolvers) {
this.skipDefaultResolvers = skipDefaultResolvers;
}
@Override
public boolean isOracleSqlplus() {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("oracle.sqlplus");
}
Whether to Flyway's support for Oracle SQL*Plus commands should be activated.
Flyway Pro and Flyway Enterprise only
Params: - oracleSqlplus –
true
to active SQL*Plus support. false
to fail fast instead. (default: false
)
/**
* Whether to Flyway's support for Oracle SQL*Plus commands should be activated.
* <p><i>Flyway Pro and Flyway Enterprise only</i></p>
*
* @param oracleSqlplus {@code true} to active SQL*Plus support. {@code false} to fail fast instead. (default: {@code false})
*/
public void setOracleSqlplus(boolean oracleSqlplus) {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("oracle.sqlplus");
}
@Override
public boolean isOracleSqlplusWarn() {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("oracle.sqlplusWarn");
}
Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement
it doesn't yet support.
Flyway Pro and Flyway Enterprise only
Params: - oracleSqlplusWarn –
true
to issue a warning. false
to fail fast instead. (default: false
)
/**
* Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement
* it doesn't yet support.
*
* <p><i>Flyway Pro and Flyway Enterprise only</i></p>
*
* @param oracleSqlplusWarn {@code true} to issue a warning. {@code false} to fail fast instead. (default: {@code false})
*/
public void setOracleSqlplusWarn(boolean oracleSqlplusWarn) {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("oracle.sqlplusWarn");
}
Your Flyway license key (FL01...). Not yet a Flyway Pro or Enterprise Edition customer?
Request your Flyway trial license key
to try out Flyway Pro and Enterprise Edition features free for 30 days.
Flyway Pro and Flyway Enterprise only
Params: - licenseKey – Your Flyway license key.
/**
* Your Flyway license key (FL01...). Not yet a Flyway Pro or Enterprise Edition customer?
* Request your <a href="https://flywaydb.org/download/">Flyway trial license key</a>
* to try out Flyway Pro and Enterprise Edition features free for 30 days.
*
* <p><i>Flyway Pro and Flyway Enterprise only</i></p>
*
* @param licenseKey Your Flyway license key.
*/
public void setLicenseKey(String licenseKey) {
LOG.warn(Edition.PRO + " or " + Edition.ENTERPRISE + " upgrade required: " + licenseKey
+ " is not supported by " + Edition.COMMUNITY + ".");
}
Configure with the same values as this existing configuration.
Params: - configuration – The configuration to use.
/**
* Configure with the same values as this existing configuration.
*
* @param configuration The configuration to use.
*/
public void configure(Configuration configuration) {
setBaselineDescription(configuration.getBaselineDescription());
setBaselineOnMigrate(configuration.isBaselineOnMigrate());
setBaselineVersion(configuration.getBaselineVersion());
setCallbacks(configuration.getCallbacks());
setCleanDisabled(configuration.isCleanDisabled());
setCleanOnValidationError(configuration.isCleanOnValidationError());
setDataSource(configuration.getDataSource());
setConnectRetries(configuration.getConnectRetries());
setInitSql(configuration.getInitSql());
setEncoding(configuration.getEncoding());
setGroup(configuration.isGroup());
setValidateMigrationNaming(configuration.isValidateMigrationNaming());
setIgnoreFutureMigrations(configuration.isIgnoreFutureMigrations());
setIgnoreMissingMigrations(configuration.isIgnoreMissingMigrations());
setIgnoreIgnoredMigrations(configuration.isIgnoreIgnoredMigrations());
setIgnorePendingMigrations(configuration.isIgnorePendingMigrations());
setInstalledBy(configuration.getInstalledBy());
setJavaMigrations(configuration.getJavaMigrations());
setLocations(configuration.getLocations());
setMixed(configuration.isMixed());
setOutOfOrder(configuration.isOutOfOrder());
setPlaceholderPrefix(configuration.getPlaceholderPrefix());
setPlaceholderReplacement(configuration.isPlaceholderReplacement());
setPlaceholders(configuration.getPlaceholders());
setPlaceholderSuffix(configuration.getPlaceholderSuffix());
setRepeatableSqlMigrationPrefix(configuration.getRepeatableSqlMigrationPrefix());
setResolvers(configuration.getResolvers());
setDefaultSchema(configuration.getDefaultSchema());
setSchemas(configuration.getSchemas());
setSkipDefaultCallbacks(configuration.isSkipDefaultCallbacks());
setSkipDefaultResolvers(configuration.isSkipDefaultResolvers());
setSqlMigrationPrefix(configuration.getSqlMigrationPrefix());
setSqlMigrationSeparator(configuration.getSqlMigrationSeparator());
setSqlMigrationSuffixes(configuration.getSqlMigrationSuffixes());
setTable(configuration.getTable());
setTablespace(configuration.getTablespace());
setTarget(configuration.getTarget());
setValidateOnMigrate(configuration.isValidateOnMigrate());
}
Whether Flyway should output a table with the results of queries when executing migrations.
Flyway Pro and Flyway Enterprise only
Returns: true
to output the results table (default: true
)
/**
* Whether Flyway should output a table with the results of queries when executing migrations.
*
* <p><i>Flyway Pro and Flyway Enterprise only</i></p>
*
* @return {@code true} to output the results table (default: {@code true})
*/
private void setOutputQueryResults(boolean outputQueryResults) {
throw new org.flywaydb.core.internal.license.FlywayProUpgradeRequiredException("outputQueryResults");
}
Configures Flyway with these properties. This overwrites any existing configuration. Property names are
documented in the flyway maven plugin.
To use a custom ClassLoader, setClassLoader() must be called prior to calling this method.
Params: - properties – Properties used for configuration.
Throws: - FlywayException – when the configuration failed.
/**
* Configures Flyway with these properties. This overwrites any existing configuration. Property names are
* documented in the flyway maven plugin.
* <p>To use a custom ClassLoader, setClassLoader() must be called prior to calling this method.</p>
*
* @param properties Properties used for configuration.
* @throws FlywayException when the configuration failed.
*/
public void configure(Properties properties) {
configure(ConfigUtils.propertiesToMap(properties));
}
Configures Flyway with these properties. This overwrites any existing configuration. Property names are
documented in the flyway maven plugin.
To use a custom ClassLoader, it must be passed to the Flyway constructor prior to calling this method.
Params: - props – Properties used for configuration.
Throws: - FlywayException – when the configuration failed.
/**
* Configures Flyway with these properties. This overwrites any existing configuration. Property names are
* documented in the flyway maven plugin.
* <p>To use a custom ClassLoader, it must be passed to the Flyway constructor prior to calling this method.</p>
*
* @param props Properties used for configuration.
* @throws FlywayException when the configuration failed.
*/
public void configure(Map<String, String> props) {
// Make copy to prevent removing elements from the original.
props = new HashMap<>(props);
String driverProp = props.remove(ConfigUtils.DRIVER);
if (driverProp != null) {
dataSource = null;
driver = driverProp;
}
String urlProp = props.remove(ConfigUtils.URL);
if (urlProp != null) {
dataSource = null;
url = urlProp;
}
String userProp = props.remove(ConfigUtils.USER);
if (userProp != null) {
dataSource = null;
user = userProp;
}
String passwordProp = props.remove(ConfigUtils.PASSWORD);
if (passwordProp != null) {
dataSource = null;
password = passwordProp;
}
if (StringUtils.hasText(url) && (StringUtils.hasText(urlProp) ||
StringUtils.hasText(driverProp) || StringUtils.hasText(userProp) || StringUtils.hasText(passwordProp))) {
setDataSource(new DriverDataSource(classLoader, driver, url, user, password));
}
Integer connectRetriesProp = removeInteger(props, ConfigUtils.CONNECT_RETRIES);
if (connectRetriesProp != null) {
setConnectRetries(connectRetriesProp);
}
String initSqlProp = props.remove(ConfigUtils.INIT_SQL);
if (initSqlProp != null) {
setInitSql(initSqlProp);
}
String locationsProp = props.remove(ConfigUtils.LOCATIONS);
if (locationsProp != null) {
setLocationsAsStrings(StringUtils.tokenizeToStringArray(locationsProp, ","));
}
Boolean placeholderReplacementProp = removeBoolean(props, ConfigUtils.PLACEHOLDER_REPLACEMENT);
if (placeholderReplacementProp != null) {
setPlaceholderReplacement(placeholderReplacementProp);
}
String placeholderPrefixProp = props.remove(ConfigUtils.PLACEHOLDER_PREFIX);
if (placeholderPrefixProp != null) {
setPlaceholderPrefix(placeholderPrefixProp);
}
String placeholderSuffixProp = props.remove(ConfigUtils.PLACEHOLDER_SUFFIX);
if (placeholderSuffixProp != null) {
setPlaceholderSuffix(placeholderSuffixProp);
}
String sqlMigrationPrefixProp = props.remove(ConfigUtils.SQL_MIGRATION_PREFIX);
if (sqlMigrationPrefixProp != null) {
setSqlMigrationPrefix(sqlMigrationPrefixProp);
}
String undoSqlMigrationPrefixProp = props.remove(ConfigUtils.UNDO_SQL_MIGRATION_PREFIX);
if (undoSqlMigrationPrefixProp != null) {
setUndoSqlMigrationPrefix(undoSqlMigrationPrefixProp);
}
String repeatableSqlMigrationPrefixProp = props.remove(ConfigUtils.REPEATABLE_SQL_MIGRATION_PREFIX);
if (repeatableSqlMigrationPrefixProp != null) {
setRepeatableSqlMigrationPrefix(repeatableSqlMigrationPrefixProp);
}
String sqlMigrationSeparatorProp = props.remove(ConfigUtils.SQL_MIGRATION_SEPARATOR);
if (sqlMigrationSeparatorProp != null) {
setSqlMigrationSeparator(sqlMigrationSeparatorProp);
}
String sqlMigrationSuffixesProp = props.remove(ConfigUtils.SQL_MIGRATION_SUFFIXES);
if (sqlMigrationSuffixesProp != null) {
setSqlMigrationSuffixes(StringUtils.tokenizeToStringArray(sqlMigrationSuffixesProp, ","));
}
String encodingProp = props.remove(ConfigUtils.ENCODING);
if (encodingProp != null) {
setEncodingAsString(encodingProp);
}
String defaultSchemaProp = props.remove(ConfigUtils.DEFAULT_SCHEMA);
if (defaultSchemaProp != null) {
setDefaultSchema(defaultSchemaProp);
}
String schemasProp = props.remove(ConfigUtils.SCHEMAS);
if (schemasProp != null) {
setSchemas(StringUtils.tokenizeToStringArray(schemasProp, ","));
}
String tableProp = props.remove(ConfigUtils.TABLE);
if (tableProp != null) {
setTable(tableProp);
}
String tablespaceProp = props.remove(ConfigUtils.TABLESPACE);
if (tablespaceProp != null) {
setTablespace(tablespaceProp);
}
Boolean cleanOnValidationErrorProp = removeBoolean(props, ConfigUtils.CLEAN_ON_VALIDATION_ERROR);
if (cleanOnValidationErrorProp != null) {
setCleanOnValidationError(cleanOnValidationErrorProp);
}
Boolean cleanDisabledProp = removeBoolean(props, ConfigUtils.CLEAN_DISABLED);
if (cleanDisabledProp != null) {
setCleanDisabled(cleanDisabledProp);
}
Boolean validateOnMigrateProp = removeBoolean(props, ConfigUtils.VALIDATE_ON_MIGRATE);
if (validateOnMigrateProp != null) {
setValidateOnMigrate(validateOnMigrateProp);
}
String baselineVersionProp = props.remove(ConfigUtils.BASELINE_VERSION);
if (baselineVersionProp != null) {
setBaselineVersion(MigrationVersion.fromVersion(baselineVersionProp));
}
String baselineDescriptionProp = props.remove(ConfigUtils.BASELINE_DESCRIPTION);
if (baselineDescriptionProp != null) {
setBaselineDescription(baselineDescriptionProp);
}
Boolean baselineOnMigrateProp = removeBoolean(props, ConfigUtils.BASELINE_ON_MIGRATE);
if (baselineOnMigrateProp != null) {
setBaselineOnMigrate(baselineOnMigrateProp);
}
Boolean ignoreMissingMigrationsProp = removeBoolean(props, ConfigUtils.IGNORE_MISSING_MIGRATIONS);
if (ignoreMissingMigrationsProp != null) {
setIgnoreMissingMigrations(ignoreMissingMigrationsProp);
}
Boolean ignoreIgnoredMigrationsProp = removeBoolean(props, ConfigUtils.IGNORE_IGNORED_MIGRATIONS);
if (ignoreIgnoredMigrationsProp != null) {
setIgnoreIgnoredMigrations(ignoreIgnoredMigrationsProp);
}
Boolean ignorePendingMigrationsProp = removeBoolean(props, ConfigUtils.IGNORE_PENDING_MIGRATIONS);
if (ignorePendingMigrationsProp != null) {
setIgnorePendingMigrations(ignorePendingMigrationsProp);
}
Boolean ignoreFutureMigrationsProp = removeBoolean(props, ConfigUtils.IGNORE_FUTURE_MIGRATIONS);
if (ignoreFutureMigrationsProp != null) {
setIgnoreFutureMigrations(ignoreFutureMigrationsProp);
}
Boolean validateMigrationNamingProp = removeBoolean(props, ConfigUtils.VALIDATE_MIGRATION_NAMING);
if (validateMigrationNamingProp != null) {
setValidateMigrationNaming(validateMigrationNamingProp);
}
String targetProp = props.remove(ConfigUtils.TARGET);
if (targetProp != null) {
setTarget(MigrationVersion.fromVersion(targetProp));
}
Boolean outOfOrderProp = removeBoolean(props, ConfigUtils.OUT_OF_ORDER);
if (outOfOrderProp != null) {
setOutOfOrder(outOfOrderProp);
}
Boolean outputQueryResultsProp = removeBoolean(props, ConfigUtils.OUTPUT_QUERY_RESULTS);
if (outputQueryResultsProp != null) {
setOutputQueryResults(outputQueryResultsProp);
}
String resolversProp = props.remove(ConfigUtils.RESOLVERS);
if (StringUtils.hasLength(resolversProp)) {
setResolversAsClassNames(StringUtils.tokenizeToStringArray(resolversProp, ","));
}
Boolean skipDefaultResolversProp = removeBoolean(props, ConfigUtils.SKIP_DEFAULT_RESOLVERS);
if (skipDefaultResolversProp != null) {
setSkipDefaultResolvers(skipDefaultResolversProp);
}
String callbacksProp = props.remove(ConfigUtils.CALLBACKS);
if (StringUtils.hasLength(callbacksProp)) {
setCallbacksAsClassNames(StringUtils.tokenizeToStringArray(callbacksProp, ","));
}
Boolean skipDefaultCallbacksProp = removeBoolean(props, ConfigUtils.SKIP_DEFAULT_CALLBACKS);
if (skipDefaultCallbacksProp != null) {
setSkipDefaultCallbacks(skipDefaultCallbacksProp);
}
Map<String, String> placeholdersFromProps = new HashMap<>(getPlaceholders());
Iterator<Map.Entry<String, String>> iterator = props.entrySet().iterator();
while (iterator.hasNext()) {
Map.Entry<String, String> entry = iterator.next();
String propertyName = entry.getKey();
if (propertyName.startsWith(ConfigUtils.PLACEHOLDERS_PROPERTY_PREFIX)
&& propertyName.length() > ConfigUtils.PLACEHOLDERS_PROPERTY_PREFIX.length()) {
String placeholderName = propertyName.substring(ConfigUtils.PLACEHOLDERS_PROPERTY_PREFIX.length());
String placeholderValue = entry.getValue();
placeholdersFromProps.put(placeholderName, placeholderValue);
iterator.remove();
}
}
setPlaceholders(placeholdersFromProps);
Boolean mixedProp = removeBoolean(props, ConfigUtils.MIXED);
if (mixedProp != null) {
setMixed(mixedProp);
}
Boolean groupProp = removeBoolean(props, ConfigUtils.GROUP);
if (groupProp != null) {
setGroup(groupProp);
}
String installedByProp = props.remove(ConfigUtils.INSTALLED_BY);
if (installedByProp != null) {
setInstalledBy(installedByProp);
}
String dryRunOutputProp = props.remove(ConfigUtils.DRYRUN_OUTPUT);
if (dryRunOutputProp != null) {
setDryRunOutputAsFileName(dryRunOutputProp);
}
String errorOverridesProp = props.remove(ConfigUtils.ERROR_OVERRIDES);
if (errorOverridesProp != null) {
setErrorOverrides(StringUtils.tokenizeToStringArray(errorOverridesProp, ","));
}
Boolean streamProp = removeBoolean(props, ConfigUtils.STREAM);
if (streamProp != null) {
setStream(streamProp);
}
Boolean batchProp = removeBoolean(props, ConfigUtils.BATCH);
if (batchProp != null) {
setBatch(batchProp);
}
Boolean oracleSqlplusProp = removeBoolean(props, ConfigUtils.ORACLE_SQLPLUS);
if (oracleSqlplusProp != null) {
setOracleSqlplus(oracleSqlplusProp);
}
Boolean oracleSqlplusWarnProp = removeBoolean(props, ConfigUtils.ORACLE_SQLPLUS_WARN);
if (oracleSqlplusWarnProp != null) {
setOracleSqlplusWarn(oracleSqlplusWarnProp);
}
String licenseKeyProp = props.remove(ConfigUtils.LICENSE_KEY);
if (licenseKeyProp != null) {
setLicenseKey(licenseKeyProp);
}
ConfigUtils.checkConfigurationForUnrecognisedProperties(props, "flyway.");
}
Configures Flyway using FLYWAY_* environment variables.
/**
* Configures Flyway using FLYWAY_* environment variables.
*/
public void configureUsingEnvVars() {
configure(ConfigUtils.environmentVariablesToPropertyMap());
}
}