Package io.quarkus.flyway.runtime

Class FlywayDataSourceRuntimeConfig

java.lang.Object
io.quarkus.flyway.runtime.FlywayDataSourceRuntimeConfig
public final class FlywayDataSourceRuntimeConfig extends Object

  • Field Details

    • active

      @ConfigItem(defaultValueDocumentation="\'true\' if the datasource is active; \'false\' otherwise") public Optional<Boolean> active
      Flag to activate/deactivate Flyway for a specific datasource at runtime.

    • connectRetries

      @ConfigItem public OptionalInt connectRetries
      The maximum number of retries when attempting to connect to the database.

      After each failed attempt, Flyway will wait up to the configured `connect-retries-interval` duration before attempting to connect again, up to the maximum number of times specified by connectRetries.

    • connectRetriesInterval

      @ConfigItem(defaultValueDocumentation="120 seconds") public Optional<Duration> connectRetriesInterval
      The maximum time between retries when attempting to connect to the database.

      This will cap the interval between connect retries to the value provided.

    • defaultSchema

      @ConfigItem public Optional<String> defaultSchema
      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).

    • jdbcUrl

      @ConfigItem public Optional<String> jdbcUrl
      The JDBC URL that Flyway uses to connect to the database. Falls back to the datasource URL if not specified.

    • username

      @ConfigItem public Optional<String> username
      The username that Flyway uses to connect to the database. If no specific JDBC URL is configured, falls back to the datasource username if not specified.

    • password

      @ConfigItem public Optional<String> password
      The password that Flyway uses to connect to the database. If no specific JDBC URL is configured, falls back to the datasource password if not specified.

    • schemas

      @ConfigItem public Optional<List<String>> schemas
      Comma-separated case-sensitive list of schemas managed by Flyway. The first schema in the list will be automatically set as the default one during the migration. It will also be the one containing the schema history table.

    • table

      @ConfigItem public Optional<String> table
      The name of Flyway's schema history table. 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.

    • sqlMigrationPrefix

      @ConfigItem public Optional<String> sqlMigrationPrefix
      The file name prefix for versioned SQL migrations. Versioned SQL migrations have the following file name structure: prefixVERSIONseparatorDESCRIPTIONsuffix , which using the defaults translates to V1.1__My_description.sql

    • repeatableSqlMigrationPrefix

      @ConfigItem public Optional<String> repeatableSqlMigrationPrefix
      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

    • cleanAtStart

      @ConfigItem public boolean cleanAtStart
      true to execute Flyway clean command automatically when the application starts, false otherwise.

    • cleanDisabled

      @ConfigItem public boolean cleanDisabled
      true to prevent Flyway clean operations, false otherwise.

    • cleanOnValidationError

      @ConfigItem public boolean cleanOnValidationError
      true to automatically call clean when a validation error occurs, false otherwise.

    • migrateAtStart

      @ConfigItem public boolean migrateAtStart
      true to execute Flyway automatically when the application starts, false otherwise.

    • repairAtStart

      @ConfigItem public boolean repairAtStart
      true to execute a Flyway repair command when the application starts, false otherwise.

    • validateAtStart

      @ConfigItem public boolean validateAtStart
      true to execute a Flyway validate command when the application starts, false otherwise.

    • baselineOnMigrate

      @ConfigItem public boolean baselineOnMigrate
      true to execute Flyway baseline before migrations This flag is ignored if the flyway_schema_history table exists in the current schema or if the current schema is empty. Note that this will not automatically call migrate, you must either enable baselineAtStart or programmatically call flyway.migrate().

    • baselineAtStart

      @ConfigItem public boolean baselineAtStart
      true to execute Flyway baseline automatically when the application starts. This flag is ignored if the flyway_schema_history table exists in the current schema. This will work even if the current schema is empty.

    • baselineVersion

      @ConfigItem public Optional<String> baselineVersion
      The initial baseline version.

    • baselineDescription

      @ConfigItem public Optional<String> baselineDescription
      The description to tag an existing schema with when executing baseline.

    • validateOnMigrate

      @ConfigItem(defaultValue="true") public boolean validateOnMigrate
      Whether to automatically call validate when performing a migration.

    • outOfOrder

      @ConfigItem public boolean outOfOrder
      Allows migrations to be run "out of order".

    • ignoreMissingMigrations

      @ConfigItem public boolean ignoreMissingMigrations
      Ignore missing migrations when reading the history table. When set to true migrations from older versions present in the history table but absent in the configured locations will be ignored (and logged as a warning), when false (the default) the validation step will fail.

    • ignoreFutureMigrations

      @ConfigItem public boolean ignoreFutureMigrations
      Ignore future migrations when reading the history table. When set to true migrations from newer versions present in the history table but absent in the configured locations will be ignored (and logged as a warning), when false (the default) the validation step will fail.

    • placeholders

      @ConfigItem public Map<String,String> placeholders
      Sets the placeholders to replace in SQL migration scripts.

    • createSchemas

      @ConfigItem(defaultValue="true") public boolean createSchemas
      Whether Flyway should attempt to create the schemas specified in the schemas property

    • placeholderPrefix

      @ConfigItem public Optional<String> placeholderPrefix
      Prefix of every placeholder (default: ${ )

    • placeholderSuffix

      @ConfigItem public Optional<String> placeholderSuffix
      Suffix of every placeholder (default: } )

    • initSql

      @ConfigItem public Optional<String> initSql
      The SQL statements to run to initialize a new database connection immediately after opening it.

    • validateMigrationNaming

      @ConfigItem public 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.

    • ignoreMigrationPatterns

      @ConfigItem public Optional<String[]> ignoreMigrationPatterns
      Ignore migrations during validate and repair according to a given list of patterns (see https://flywaydb.org/documentation/configuration/parameters/ignoreMigrationPatterns for more information). When this configuration is set, the ignoreFutureMigrations and ignoreMissingMigrations settings are ignored. Patterns are comma separated.

  • Constructor Details

    • FlywayDataSourceRuntimeConfig

      public FlywayDataSourceRuntimeConfig()

  • Method Details