io.quarkus.flyway.runtime

Class FlywayDataSourceRuntimeConfig

java.lang.Object

io.quarkus.flyway.runtime.FlywayDataSourceRuntimeConfig

public final class FlywayDataSourceRuntimeConfig
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
Optional<String>	baselineDescription The description to tag an existing schema with when executing baseline.
boolean	baselineOnMigrate Enable the creation of the history table if it does not exist already.
Optional<String>	baselineVersion The initial baseline version.
boolean	cleanAtStart true to execute Flyway clean command automatically when the application starts, false otherwise.
OptionalInt	connectRetries The maximum number of retries when attempting to connect to the database.
boolean	createSchemas Whether Flyway should attempt to create the schemas specified in the schemas property
boolean	ignoreMissingMigrations Ignore missing migrations when reading the history table.
boolean	migrateAtStart true to execute Flyway automatically when the application starts, false otherwise.
boolean	outOfOrder Allows migrations to be run "out of order".
Optional<String>	placeholderPrefix Prefix of every placeholder (default: ${ )
Map<String,String>	placeholders Sets the placeholders to replace in SQL migration scripts.
Optional<String>	placeholderSuffix Suffix of every placeholder (default: } )
Optional<String>	repeatableSqlMigrationPrefix The file name prefix for repeatable SQL migrations.
Optional<List<String>>	schemas Comma-separated case-sensitive list of schemas managed by Flyway.
Optional<String>	sqlMigrationPrefix The file name prefix for versioned SQL migrations.
Optional<String>	table The name of Flyway's schema history table.
boolean	validateOnMigrate Whether to automatically call validate when performing a migration.

Constructor Summary

Constructors

Constructor and Description
FlywayDataSourceRuntimeConfig()

Method Summary

Modifier and Type	Method and Description
static FlywayDataSourceRuntimeConfig	defaultConfig() Creates a FlywayDataSourceRuntimeConfig with default settings.

Methods inherited from class java.lang.Object

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

Field Detail

connectRetries

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

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.

migrateAtStart

@ConfigItem
public boolean migrateAtStart

true to execute Flyway automatically when the application starts, false otherwise.

baselineOnMigrate

@ConfigItem
public boolean baselineOnMigrate

Enable the creation of the history table if it does not exist already.

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
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 any migration 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: } )

Constructor Detail

FlywayDataSourceRuntimeConfig

public FlywayDataSourceRuntimeConfig()

Method Detail

defaultConfig

public static final FlywayDataSourceRuntimeConfig defaultConfig()

Creates a FlywayDataSourceRuntimeConfig with default settings.

Returns:

FlywayDataSourceRuntimeConfig