Class FlywayExtension

java.lang.Object
net.ltgt.gradle.flyway.FlywayExtension
public abstract class FlywayExtension extends Object
The extension to configure all Flyway tasks in a central place.

  • Constructor Details

    • FlywayExtension

      public FlywayExtension()

  • Method Details

    • getConfigurationFile

      public abstract org.gradle.api.file.RegularFileProperty getConfigurationFile()
      The Flyway configuration file (must be a Java properties file encoded in UTF-8)

      When the java plugin is applied, it defaults to the db/flyway.conf from the main source set's resources, after it has been processed by the processResources task.

    • getConfiguration

      public abstract org.gradle.api.provider.MapProperty<String,String> getConfiguration()
      Additional configuration properties to be merged with the configuration file (overriding it).

    • getMigrationLocations

      public abstract org.gradle.api.file.ConfigurableFileCollection getMigrationLocations()
      The directories containing migration scripts.

      When the java plugin is applied, it defaults to the db/migration/ from the main source set's resources, after it has been processed by the processResources task.

    • getUrl

      public abstract org.gradle.api.provider.Property<String> getUrl()
      The jdbc url to use to connect to the database.

    • getUser

      public abstract org.gradle.api.provider.Property<String> getUser()
      The user to use to connect to the database.

    • getPassword

      public abstract org.gradle.api.provider.Property<String> getPassword()
      The password to use to connect to the database.