Class FlywayExtension

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.String baselineDescription
      The description to tag an existing schema with when executing baseline.
      java.lang.String baselineMigrationPrefix
      The file name prefix for baseline migrations.
      java.lang.Boolean baselineOnMigrate
      Whether to automatically call baseline when migrate is executed against a non-empty schema with no schema history table.
      java.lang.String baselineVersion
      The version to tag an existing schema with when executing baseline.
      java.lang.Boolean batch
      Whether to batch SQL statements when executing them.
      java.lang.String[] callbacks
      An array of fully qualified FlywayCallback class implementations, or packages to scan for FlywayCallback implementations.
      java.lang.String[] cherryPick
      Gets the migrations that Flyway should consider when migrating or undoing.
      java.lang.Boolean cleanDisabled
      Whether to disable clean.
      java.lang.Boolean cleanOnValidationError
      Whether to automatically call clean or not when a validation error occurs.
      java.lang.String configFileEncoding
      The encoding of the external config files specified with the flyway.configFiles property.
      java.lang.String[] configFiles
      Config files from which to load the Flyway configuration.
      java.lang.String[] configurations
      Gradle configurations that will be added to the classpath for running Flyway tasks.
      int connectRetries
      The maximum number of retries when attempting to connect to the database.
      int connectRetriesInterval
      The maximum time between retries when attempting to connect to the database in seconds.
      java.lang.Boolean createSchemas
      Whether Flyway should attempt to create the schemas specified in the schemas propert
      java.lang.String defaultSchema
      The default schema managed by Flyway.
      java.lang.Boolean detectEncoding
      Whether Flyway should try to automatically detect SQL migration file encoding Flyway Teams only
      java.lang.String driver
      The fully qualified classname of the JDBC driver to use to connect to the database.
      java.lang.String dryRunOutput
      The file where to output the SQL statements of a migration dry run.
      java.lang.String encoding
      The encoding of SQL migrations.
      java.lang.String[] errorOverrides
      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.
      java.lang.Boolean failOnMissingLocations
      Whether to fail if a location specified in the flyway.locations option doesn't exist
      java.lang.Boolean group
      Whether to group all pending migrations together in the same transaction when applying them (only recommended for databases with support for DDL transactions).
      java.lang.Boolean ignoreFutureMigrations
      Deprecated.
      Will remove in Flyway V9.
      java.lang.Boolean ignoreIgnoredMigrations
      Deprecated.
      Will remove in Flyway V9.
      java.lang.String[] ignoreMigrationPatterns
      Ignore migrations that match this comma-separated list of patterns when validating migrations.
      java.lang.Boolean ignoreMissingMigrations
      Deprecated.
      Will remove in Flyway V9.
      java.lang.Boolean ignorePendingMigrations
      Deprecated.
      Will remove in Flyway V9.
      java.lang.String initSql
      The SQL statements to run to initialize a new database connection immediately after opening it.
      java.lang.String installedBy
      The username that will be recorded in the schema history table as having applied the migration.
      java.util.Map<java.lang.Object,​java.lang.Object> jdbcProperties
      Properties to pass to the JDBC driver object.
      java.lang.String kerberosConfigFile
      When connecting to a Kerberos service to authenticate, the path to the Kerberos config file.
      java.lang.String licenseKey
      Your Flyway license key (FL01...).
      java.lang.String[] locations
      Locations to scan recursively for migrations.
      java.lang.Integer lockRetryCount
      The maximum number of retries when trying to obtain a lock.
      java.lang.String[] loggers
      The loggers Flyway should use.
      java.lang.Boolean mixed
      Whether to allow mixing transactional and non-transactional statements within the same migration.
      java.lang.Boolean oracleSqlplus
      Whether to Flyway's support for Oracle SQL*Plus commands should be activated.
      java.lang.Boolean oracleSqlplusWarn
      Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement it doesn't yet support.
      java.lang.String oracleWalletLocation
      The location of your Oracle wallet, used to automatically sign in to your databases.
      java.lang.Boolean outOfOrder
      Allows migrations to be run "out of order".
      java.lang.Boolean outputQueryResults
      Whether Flyway should output a table with the results of queries when executing migrations (default: true).
      java.lang.String password
      The password to use to connect to the database.
      java.lang.String placeholderPrefix
      The prefix of every placeholder.
      java.lang.Boolean placeholderReplacement
      Whether placeholders should be replaced.
      java.util.Map<java.lang.Object,​java.lang.Object> placeholders
      Placeholders to replace in SQL migrations.
      java.lang.String placeholderSuffix
      The suffix of every placeholder.
      java.util.Map<java.lang.String,​java.lang.String> pluginConfiguration
      The configuration for plugins You will need to configure this with the key and value specific to your plugin
      java.lang.String repeatableSqlMigrationPrefix
      The file name prefix for repeatable SQL migrations (default: R).
      java.lang.String[] resolvers
      The fully qualified class names of the custom MigrationResolvers to be used in addition (default) or as a replacement (using skipDefaultResolvers) to the built-in ones for resolving Migrations to apply.
      java.lang.String[] schemas
      The schemas managed by Flyway.
      java.lang.String scriptPlaceholderPrefix
      The prefix of every script placeholder.
      java.lang.String scriptPlaceholderSuffix
      The suffix of every script placeholder.
      java.lang.Boolean skipDefaultCallbacks
      If set to true, default built-in callbacks will be skipped, only custom migration callbacks will be used.
      java.lang.Boolean skipDefaultResolvers
      If set to true, default built-in resolvers will be skipped, only custom migration resolvers will be used.
      java.lang.Boolean skipExecutingMigrations
      Whether Flyway should skip actually executing the contents of the migrations and only update the schema history table.
      java.lang.String sqlMigrationPrefix
      The file name prefix for versioned SQL migrations.
      java.lang.String sqlMigrationSeparator
      The file name prefix for Sql migrations SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix, which using the defaults translates to V1_1__My_description.sql
      java.lang.String[] sqlMigrationSuffixes
      The file name suffixes for SQL migrations.
      java.lang.Boolean stream
      Whether to stream SQL migrations when executing them.
      java.lang.String table
      The name of the schema history table that will be used by Flyway.
      java.lang.String tablespace
      The tablespace where to create the schema history table that will be used by Flyway.
      java.lang.String target
      The target version up to which Flyway should consider migrations.
      java.lang.String undoSqlMigrationPrefix
      The file name prefix for undo SQL migrations.
      java.lang.String url
      The JDBC url to use to connect to the database.
      java.lang.String user
      The user to use to connect to the database.
      java.lang.Boolean validateMigrationNaming
      Whether to validate migrations and callbacks whose scripts do not obey the correct naming convention.
      java.lang.Boolean validateOnMigrate
      Whether to automatically call validate or not when running migrate.
      java.lang.String workingDirectory
      The working directory to consider when dealing with relative paths for both config files and locations.
    • Constructor Summary

      Constructors 
      Constructor Description
      FlywayExtension()  
    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • driver

        public java.lang.String driver
        The fully qualified classname of the JDBC driver to use to connect to the database.
      • url

        public java.lang.String url
        The JDBC url to use to connect to the database.
      • user

        public java.lang.String user
        The user to use to connect to the database.
      • password

        public java.lang.String password
        The password to use to connect to the database.
      • connectRetries

        public int connectRetries
        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. The interval between retries doubles with each subsequent attempt. (default: 0)

        Also configurable with Gradle or System Property: ${flyway.connectRetries}

      • connectRetriesInterval

        public int connectRetriesInterval
        The maximum time between retries when attempting to connect to the database in seconds. This will cap the interval between connect retry to the value provided. (default: 120)

        Also configurable with Gradle or System Property: ${flyway.connectRetriesInterval}

      • initSql

        public java.lang.String initSql
        The SQL statements to run to initialize a new database connection immediately after opening it. (default: null)

        Also configurable with Gradle or System Property: ${flyway.initSql}

      • table

        public java.lang.String table
        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, or in the schema specified to flyway.defaultSchema.

        Also configurable with Gradle or System Property: ${flyway.table}

      • tablespace

        public java.lang.String tablespace
        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.

        Also configurable with Gradle or System Property: ${flyway.tablespace}

      • defaultSchema

        public java.lang.String defaultSchema
        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).

        Also configurable with Gradle or System Property: ${flyway.defaultSchema}

      • schemas

        public java.lang.String[] schemas
        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.

        Also configurable with Gradle or System Property: ${flyway.schemas} (comma-separated list)

      • baselineVersion

        public java.lang.String baselineVersion
        The version to tag an existing schema with when executing baseline. (default: 1)
      • baselineDescription

        public java.lang.String baselineDescription
        The description to tag an existing schema with when executing baseline. (default: << Flyway Baseline >>)
      • locations

        public java.lang.String[] locations
        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. (default: filesystem:src/main/resources/db/migration)
      • resolvers

        public java.lang.String[] resolvers
        The fully qualified class names of the custom MigrationResolvers to be used in addition (default) or as a replacement (using skipDefaultResolvers) to the built-in ones for resolving Migrations to apply. (default: none)<
      • skipDefaultResolvers

        public java.lang.Boolean skipDefaultResolvers
        If set to true, default built-in resolvers will be skipped, only custom migration resolvers will be used. (default: false)
      • sqlMigrationPrefix

        public java.lang.String sqlMigrationPrefix
        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

        Also configurable with Gradle or System Property: ${flyway.sqlMigrationPrefix}

      • baselineMigrationPrefix

        public java.lang.String baselineMigrationPrefix
        The file name prefix for baseline migrations. (default: B) They have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix, which using the defaults translates to B1.1__My_description.sql Flyway Teams only

        Also configurable with Gradle or System Property: ${flyway.baselineMigrationPrefix}

      • undoSqlMigrationPrefix

        public java.lang.String undoSqlMigrationPrefix
        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 Teams only

        Also configurable with Gradle or System Property: ${flyway.undoSqlMigrationPrefix}

      • repeatableSqlMigrationPrefix

        public java.lang.String repeatableSqlMigrationPrefix
        The file name prefix for repeatable SQL migrations (default: R). Repeatable SQL migrations have the following file name structure: prefixSeparatorDESCRIPTIONsuffix, which using the defaults translates to R__My_description.sql

        Also configurable with Gradle or System Property: ${flyway.repeatableSqlMigrationPrefix}

      • sqlMigrationSeparator

        public java.lang.String sqlMigrationSeparator
        The file name prefix for Sql migrations SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix, which using the defaults translates to V1_1__My_description.sql
      • sqlMigrationSuffixes

        public java.lang.String[] sqlMigrationSuffixes
        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.

        Also configurable with Gradle or System Property: ${flyway.sqlMigrationSuffixes}

      • encoding

        public java.lang.String encoding
        The encoding of SQL migrations.
      • detectEncoding

        public java.lang.Boolean detectEncoding
        Whether Flyway should try to automatically detect SQL migration file encoding Flyway Teams only

        Also configurable with Gradle or System Property: ${flyway.detectEncoding}

      • lockRetryCount

        public java.lang.Integer lockRetryCount
        The maximum number of retries when trying to obtain a lock. (default: 50)
      • placeholders

        public java.util.Map<java.lang.Object,​java.lang.Object> placeholders
        Placeholders to replace in SQL migrations.
      • jdbcProperties

        public java.util.Map<java.lang.Object,​java.lang.Object> jdbcProperties
        Properties to pass to the JDBC driver object. Flyway Teams only

        Also configurable with Gradle or System Property: ${flyway.jdbcProperties}

      • placeholderReplacement

        public java.lang.Boolean placeholderReplacement
        Whether placeholders should be replaced.
      • placeholderPrefix

        public java.lang.String placeholderPrefix
        The prefix of every placeholder.
      • placeholderSuffix

        public java.lang.String placeholderSuffix
        The suffix of every placeholder.
      • scriptPlaceholderPrefix

        public java.lang.String scriptPlaceholderPrefix
        The prefix of every script placeholder.
      • scriptPlaceholderSuffix

        public java.lang.String scriptPlaceholderSuffix
        The suffix of every script placeholder.
      • target

        public java.lang.String target
        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
        • next: The next version of the schema, as defined by the first pending migration
        • <version>? (end with a '?'): Instructs Flyway not to fail if the target version doesn't exist. In this case, Flyway will go up to but not beyond the specified target (default: fail if the target version doesn't exist) Flyway Teams only
        Defaults to latest.
      • cherryPick

        public java.lang.String[] cherryPick
        Gets the migrations that Flyway should consider when migrating or undoing. Leave empty to consider all available migrations. Migrations not in this list will be ignored. Values should be the version for versioned migrations (e.g. 1, 2.4, 6.5.3) or the description for repeatable migrations (e.g. Insert_Data, Create_Table) Flyway Teams only
      • loggers

        public java.lang.String[] loggers
        The loggers Flyway should use. Valid options are:
        • auto: Auto detect the logger (default behavior)
        • console: Use stdout/stderr (only available when using the CLI)
        • slf4j2: Use the slf4j2 logger
        • log4j2: Use the log4j2 logger
        • apache-commons: Use the Apache Commons logger
        Alternatively you can provide the fully qualified class name for any other logger to use that.
      • callbacks

        public java.lang.String[] callbacks
        An array of fully qualified FlywayCallback class implementations, or packages to scan for FlywayCallback implementations.
      • skipDefaultCallbacks

        public java.lang.Boolean skipDefaultCallbacks
        If set to true, default built-in callbacks will be skipped, only custom migration callbacks will be used. (default: false)
      • outOfOrder

        public java.lang.Boolean outOfOrder
        Allows migrations to be run "out of order".
      • skipExecutingMigrations

        public java.lang.Boolean skipExecutingMigrations
        Whether Flyway should skip actually executing the contents of the migrations and only update the schema history table. This should be used when you have applied a migration manually (via executing the sql yourself, or via an ide), and just want the schema history table to reflect this. Use in conjunction with cherryPick to skip specific migrations instead of all pending ones.
      • outputQueryResults

        public java.lang.Boolean outputQueryResults
        Whether Flyway should output a table with the results of queries when executing migrations (default: true). Flyway Teams only

        Also configurable with Gradle or System Property: ${flyway.outputQueryResults}

      • validateOnMigrate

        public java.lang.Boolean validateOnMigrate
        Whether to automatically call validate or not when running migrate. (default: true)
      • cleanOnValidationError

        public java.lang.Boolean cleanOnValidationError
        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!

        Also configurable with Gradle or System Property: ${flyway.cleanOnValidationError}

      • ignoreMissingMigrations

        public java.lang.Boolean ignoreMissingMigrations
        Deprecated.
        Will remove in Flyway V9. Use ignoreMigrationPatterns instead. 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.(default: false)

        Also configurable with Gradle or System Property: ${flyway.ignoreMissingMigrations}

      • ignoreIgnoredMigrations

        public java.lang.Boolean ignoreIgnoredMigrations
        Deprecated.
        Will remove in Flyway V9. Use ignoreMigrationPatterns instead. 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.(default: false)

        Also configurable with Gradle or System Property: ${flyway.ignoreIgnoredMigrations}

      • ignorePendingMigrations

        public java.lang.Boolean ignorePendingMigrations
        Deprecated.
        Will remove in Flyway V9. Use ignoreMigrationPatterns instead. 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. (default: false)

        Also configurable with Gradle or System Property: ${flyway.ignorePendingMigrations}

      • ignoreFutureMigrations

        public java.lang.Boolean ignoreFutureMigrations
        Deprecated.
        Will remove in Flyway V9. Use ignoreMigrationPatterns instead. 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)

        Also configurable with Gradle or System Property: ${flyway.ignoreFutureMigrations}

      • ignoreMigrationPatterns

        public java.lang.String[] ignoreMigrationPatterns
        Ignore migrations that match this comma-separated list of patterns when validating migrations. Each pattern is of the form : See https://flywaydb.org/documentation/configuration/parameters/ignoreMigrationPatterns for full details Example: repeatable:missing,versioned:pending,*:failed Flyway Teams only
      • validateMigrationNaming

        public java.lang.Boolean validateMigrationNaming
        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)

        Also configurable with Gradle or System Property: ${flyway.validateMigrationNaming}

      • cleanDisabled

        public java.lang.Boolean cleanDisabled
        Whether to disable clean. (default: false) This is especially useful for production environments where running clean can be quite a career limiting move.
      • baselineOnMigrate

        public java.lang.Boolean baselineOnMigrate
        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!

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

      • mixed

        public java.lang.Boolean mixed
        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.

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

      • group

        public java.lang.Boolean group
        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)

      • installedBy

        public java.lang.String installedBy
        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).
      • configurations

        public java.lang.String[] configurations
        Gradle configurations that will be added to the classpath for running Flyway tasks. (default: compile, runtime, testCompile, testRuntime)

        Also configurable with Gradle or System Property: ${flyway.configurations}

      • errorOverrides

        public java.lang.String[] errorOverrides
        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 Teams only

        Also configurable with Gradle or System Property: ${flyway.errorOverrides}

      • dryRunOutput

        public java.lang.String dryRunOutput
        The file where to output the SQL statements of a migration dry run. If the file specified is in a non-existent directory, Flyway will create all directories and parent directories as needed. Paths starting with s3: point to a bucket in AWS S3, which must exist. They are in the format s3:(/optionalfolder/subfolder)/filename.sql Paths starting with gcs: point to a bucket in Google Cloud Storage, which must exist. They are in the format gcs:(/optionalfolder/subfolder)/filename.sql

        null to execute the SQL statements directly against the database. (default: null)

        Flyway Teams only

        Also configurable with Gradle or System Property: ${flyway.dryRunOutput}

      • stream

        public java.lang.Boolean 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. (default: false Flyway Teams only

        Also configurable with Gradle or System Property: ${flyway.stream}

      • batch

        public java.lang.Boolean 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. (default: false) Flyway Teams only

        Also configurable with Gradle or System Property: ${flyway.batch}

      • oracleSqlplus

        public java.lang.Boolean oracleSqlplus
        Whether to Flyway's support for Oracle SQL*Plus commands should be activated. (default: false) Flyway Teams only

        Also configurable with Gradle or System Property: ${flyway.oracle.sqlplus}

      • oracleSqlplusWarn

        public java.lang.Boolean oracleSqlplusWarn
        Whether Flyway should issue a warning instead of an error whenever it encounters an Oracle SQL*Plus statement it doesn't yet support. (default: false) Flyway Teams only

        Also configurable with Gradle or System Property: ${flyway.oracle.sqlplusWarn}

      • oracleWalletLocation

        public java.lang.String oracleWalletLocation
        The location of your Oracle wallet, used to automatically sign in to your databases. Flyway Teams only

        Also configurable with Gradle or System Property: ${flyway.oracle.walletLocation}

      • kerberosConfigFile

        public java.lang.String kerberosConfigFile
        When connecting to a Kerberos service to authenticate, the path to the Kerberos config file. Flyway Teams only
      • licenseKey

        public java.lang.String licenseKey
        Your Flyway license key (FL01...). Not yet a Flyway Teams Edition customer? Request your Flyway trial license key to try out Flyway Teams Edition features free for 30 days. Flyway Teams only

        Also configurable with Gradle or System Property: ${flyway.licenseKey}

      • configFileEncoding

        public java.lang.String configFileEncoding
        The encoding of the external config files specified with the flyway.configFiles property. (default: UTF-8).

        Also configurable with Gradle or System Property: ${flyway.configFileEncoding}

      • configFiles

        public java.lang.String[] configFiles
        Config files from which to load the Flyway configuration. The names of the individual properties match the ones you would use as Gradle or System properties. The encoding of the files is defined by the flyway.configFileEncoding property, which is UTF-8 by default. Relative paths are relative to the project root.

        Also configurable with Gradle or System Property: ${flyway.configFiles}

      • workingDirectory

        public java.lang.String workingDirectory
        The working directory to consider when dealing with relative paths for both config files and locations. (default: basedir, the directory where the POM resides)

        Also configurable with Gradle or System Property: ${flyway.workingDirectory}

      • createSchemas

        public java.lang.Boolean createSchemas
        Whether Flyway should attempt to create the schemas specified in the schemas propert

        Also configurable with Gradle or System Property: ${flyway.createSchemas}

      • failOnMissingLocations

        public java.lang.Boolean failOnMissingLocations
        Whether to fail if a location specified in the flyway.locations option doesn't exist
      • pluginConfiguration

        public java.util.Map<java.lang.String,​java.lang.String> pluginConfiguration
        The configuration for plugins You will need to configure this with the key and value specific to your plugin
    • Constructor Detail

      • FlywayExtension

        public FlywayExtension()