FlywayProperties (Spring Boot 2.5.8 API)

java.lang.Object
- org.springframework.boot.autoconfigure.flyway.FlywayProperties

```
@ConfigurationProperties(prefix="spring.flyway")
public class FlywayProperties
extends Object
```
Configuration properties for Flyway database migrations.

Since:

1.1.0

Author:

Dave Syer, Eddú Meléndez, Stephane Nicoll, Chris Bono

Constructor Summary

Constructors
Constructor and Description

FlywayProperties()

Constructors
Constructor and Description
`FlywayProperties()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getBaselineDescription()`
`String`	`getBaselineVersion()`
`Boolean`	`getBatch()`
`String[]`	`getCherryPick()`
`int`	`getConnectRetries()`
`String`	`getDefaultSchema()`
`String`	`getDriverClassName()`
`File`	`getDryRunOutput()`
`Charset`	`getEncoding()`
`String[]`	`getErrorOverrides()`
`List<String>`	`getInitSqls()`
`String`	`getInstalledBy()`
`Map<String,String>`	`getJdbcProperties()`
`String`	`getLicenseKey()`
`List<String>`	`getLocations()`
`Integer`	`getLockRetryCount()`
`String`	`getOracleKerberosCacheFile()`
`String`	`getOracleKerberosConfigFile()`
`Boolean`	`getOracleSqlplus()`
`Boolean`	`getOracleSqlplusWarn()`
`Boolean`	`getOutputQueryResults()`
`String`	`getPassword()`
`String`	`getPlaceholderPrefix()`
`Map<String,String>`	`getPlaceholders()`
`String`	`getPlaceholderSuffix()`
`String`	`getRepeatableSqlMigrationPrefix()`
`List<String>`	`getSchemas()`
`Boolean`	`getSkipExecutingMigrations()`
`String`	`getSqlMigrationPrefix()`
`String`	`getSqlMigrationSeparator()`
`List<String>`	`getSqlMigrationSuffixes()`
`Boolean`	`getStream()`
`String`	`getTable()`
`String`	`getTablespace()`
`String`	`getTarget()`
`String`	`getUndoSqlMigrationPrefix()`
`String`	`getUrl()`
`String`	`getUser()`
`List<String>`	`getVaultSecrets()`
`String`	`getVaultToken()`
`String`	`getVaultUrl()`
`boolean`	`isBaselineOnMigrate()`
`boolean`	`isCheckLocation()` Deprecated.
`boolean`	`isCleanDisabled()`
`boolean`	`isCleanOnValidationError()`
`boolean`	`isCreateDataSource()` Deprecated. since 2.5.0 for removal in 2.7.0 in favor of directly checking user and url.
`boolean`	`isCreateSchemas()`
`boolean`	`isEnabled()`
`boolean`	`isGroup()`
`boolean`	`isIgnoreFutureMigrations()`
`boolean`	`isIgnoreIgnoredMigrations()`
`boolean`	`isIgnoreMissingMigrations()`
`boolean`	`isIgnorePendingMigrations()`
`boolean`	`isMixed()`
`boolean`	`isOutOfOrder()`
`boolean`	`isPlaceholderReplacement()`
`boolean`	`isSkipDefaultCallbacks()`
`boolean`	`isSkipDefaultResolvers()`
`boolean`	`isValidateMigrationNaming()`
`boolean`	`isValidateOnMigrate()`
`void`	`setBaselineDescription(String baselineDescription)`
`void`	`setBaselineOnMigrate(boolean baselineOnMigrate)`
`void`	`setBaselineVersion(String baselineVersion)`
`void`	`setBatch(Boolean batch)`
`void`	`setCheckLocation(boolean checkLocation)` Deprecated.
`void`	`setCherryPick(String[] cherryPick)`
`void`	`setCleanDisabled(boolean cleanDisabled)`
`void`	`setCleanOnValidationError(boolean cleanOnValidationError)`
`void`	`setConnectRetries(int connectRetries)`
`void`	`setCreateSchemas(boolean createSchemas)`
`void`	`setDefaultSchema(String defaultSchema)`
`void`	`setDriverClassName(String driverClassName)`
`void`	`setDryRunOutput(File dryRunOutput)`
`void`	`setEnabled(boolean enabled)`
`void`	`setEncoding(Charset encoding)`
`void`	`setErrorOverrides(String[] errorOverrides)`
`void`	`setGroup(boolean group)`
`void`	`setIgnoreFutureMigrations(boolean ignoreFutureMigrations)`
`void`	`setIgnoreIgnoredMigrations(boolean ignoreIgnoredMigrations)`
`void`	`setIgnoreMissingMigrations(boolean ignoreMissingMigrations)`
`void`	`setIgnorePendingMigrations(boolean ignorePendingMigrations)`
`void`	`setInitSqls(List<String> initSqls)`
`void`	`setInstalledBy(String installedBy)`
`void`	`setJdbcProperties(Map<String,String> jdbcProperties)`
`void`	`setLicenseKey(String licenseKey)`
`void`	`setLocations(List<String> locations)`
`void`	`setLockRetryCount(Integer lockRetryCount)`
`void`	`setMixed(boolean mixed)`
`void`	`setOracleKerberosCacheFile(String oracleKerberosCacheFile)`
`void`	`setOracleKerberosConfigFile(String oracleKerberosConfigFile)`
`void`	`setOracleSqlplus(Boolean oracleSqlplus)`
`void`	`setOracleSqlplusWarn(Boolean oracleSqlplusWarn)`
`void`	`setOutOfOrder(boolean outOfOrder)`
`void`	`setOutputQueryResults(Boolean outputQueryResults)`
`void`	`setPassword(String password)`
`void`	`setPlaceholderPrefix(String placeholderPrefix)`
`void`	`setPlaceholderReplacement(boolean placeholderReplacement)`
`void`	`setPlaceholders(Map<String,String> placeholders)`
`void`	`setPlaceholderSuffix(String placeholderSuffix)`
`void`	`setRepeatableSqlMigrationPrefix(String repeatableSqlMigrationPrefix)`
`void`	`setSchemas(List<String> schemas)`
`void`	`setSkipDefaultCallbacks(boolean skipDefaultCallbacks)`
`void`	`setSkipDefaultResolvers(boolean skipDefaultResolvers)`
`void`	`setSkipExecutingMigrations(Boolean skipExecutingMigrations)`
`void`	`setSqlMigrationPrefix(String sqlMigrationPrefix)`
`void`	`setSqlMigrationSeparator(String sqlMigrationSeparator)`
`void`	`setSqlMigrationSuffixes(List<String> sqlMigrationSuffixes)`
`void`	`setStream(Boolean stream)`
`void`	`setTable(String table)`
`void`	`setTablespace(String tablespace)`
`void`	`setTarget(String target)`
`void`	`setUndoSqlMigrationPrefix(String undoSqlMigrationPrefix)`
`void`	`setUrl(String url)`
`void`	`setUser(String user)`
`void`	`setValidateMigrationNaming(boolean validateMigrationNaming)`
`void`	`setValidateOnMigrate(boolean validateOnMigrate)`
`void`	`setVaultSecrets(List<String> vaultSecrets)`
`void`	`setVaultToken(String vaultToken)`
`void`	`setVaultUrl(String vaultUrl)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- FlywayProperties
```
public FlywayProperties()
```

Method Detail

isEnabled
```
public boolean isEnabled()
```

setEnabled

public void setEnabled(boolean enabled)

isCheckLocation

@Deprecated
 @DeprecatedConfigurationProperty(reason="Locations can no longer be checked accurately due to changes in Flyway\'s location support.")
public boolean isCheckLocation()

Deprecated.

setCheckLocation

@Deprecated
public void setCheckLocation(boolean checkLocation)

Deprecated.

getLocations
```
public List<String> getLocations()
```

setLocations

public void setLocations(List<String> locations)

getEncoding
```
public Charset getEncoding()
```

setEncoding

public void setEncoding(Charset encoding)

getConnectRetries
```
public int getConnectRetries()
```

setConnectRetries

public void setConnectRetries(int connectRetries)

getLockRetryCount
```
public Integer getLockRetryCount()
```

setLockRetryCount

public void setLockRetryCount(Integer lockRetryCount)

getDefaultSchema
```
public String getDefaultSchema()
```

setDefaultSchema

public void setDefaultSchema(String defaultSchema)

getSchemas
```
public List<String> getSchemas()
```

setSchemas

public void setSchemas(List<String> schemas)

isCreateSchemas
```
public boolean isCreateSchemas()
```

setCreateSchemas

public void setCreateSchemas(boolean createSchemas)

getTable
```
public String getTable()
```

setTable
```
public void setTable(String table)
```

getTablespace
```
public String getTablespace()
```

setTablespace

public void setTablespace(String tablespace)

getBaselineDescription

public String getBaselineDescription()

setBaselineDescription

public void setBaselineDescription(String baselineDescription)

getBaselineVersion
```
public String getBaselineVersion()
```

setBaselineVersion

public void setBaselineVersion(String baselineVersion)

getInstalledBy
```
public String getInstalledBy()
```

setInstalledBy

public void setInstalledBy(String installedBy)

getPlaceholders

public Map<String,String> getPlaceholders()

setPlaceholders

public void setPlaceholders(Map<String,String> placeholders)

getPlaceholderPrefix
```
public String getPlaceholderPrefix()
```

setPlaceholderPrefix

public void setPlaceholderPrefix(String placeholderPrefix)

getPlaceholderSuffix
```
public String getPlaceholderSuffix()
```

setPlaceholderSuffix

public void setPlaceholderSuffix(String placeholderSuffix)

isPlaceholderReplacement

public boolean isPlaceholderReplacement()

setPlaceholderReplacement

public void setPlaceholderReplacement(boolean placeholderReplacement)

getSqlMigrationPrefix
```
public String getSqlMigrationPrefix()
```

setSqlMigrationPrefix

public void setSqlMigrationPrefix(String sqlMigrationPrefix)

getSqlMigrationSuffixes

public List<String> getSqlMigrationSuffixes()

setSqlMigrationSuffixes

public void setSqlMigrationSuffixes(List<String> sqlMigrationSuffixes)

getSqlMigrationSeparator

public String getSqlMigrationSeparator()

setSqlMigrationSeparator

public void setSqlMigrationSeparator(String sqlMigrationSeparator)

getRepeatableSqlMigrationPrefix

public String getRepeatableSqlMigrationPrefix()

setRepeatableSqlMigrationPrefix

public void setRepeatableSqlMigrationPrefix(String repeatableSqlMigrationPrefix)

getTarget
```
public String getTarget()
```

setTarget
```
public void setTarget(String target)
```

isCreateDataSource
```
@Deprecated
public boolean isCreateDataSource()
```
Deprecated. since 2.5.0 for removal in 2.7.0 in favor of directly checking user and url.

Return if a new datasource is being created.

Returns:

true if a new datasource is created

getUser
```
public String getUser()
```

setUser
```
public void setUser(String user)
```

getPassword
```
public String getPassword()
```

setPassword

public void setPassword(String password)

getDriverClassName
```
public String getDriverClassName()
```

setDriverClassName

public void setDriverClassName(String driverClassName)

getUrl
```
public String getUrl()
```

setUrl
```
public void setUrl(String url)
```

getInitSqls
```
public List<String> getInitSqls()
```

setInitSqls

public void setInitSqls(List<String> initSqls)

isBaselineOnMigrate
```
public boolean isBaselineOnMigrate()
```

setBaselineOnMigrate

public void setBaselineOnMigrate(boolean baselineOnMigrate)

isCleanDisabled
```
public boolean isCleanDisabled()
```

setCleanDisabled

public void setCleanDisabled(boolean cleanDisabled)

isCleanOnValidationError

public boolean isCleanOnValidationError()

setCleanOnValidationError

public void setCleanOnValidationError(boolean cleanOnValidationError)

isGroup
```
public boolean isGroup()
```

setGroup
```
public void setGroup(boolean group)
```

isIgnoreMissingMigrations

public boolean isIgnoreMissingMigrations()

setIgnoreMissingMigrations

public void setIgnoreMissingMigrations(boolean ignoreMissingMigrations)

isIgnoreIgnoredMigrations

public boolean isIgnoreIgnoredMigrations()

setIgnoreIgnoredMigrations

public void setIgnoreIgnoredMigrations(boolean ignoreIgnoredMigrations)

isIgnorePendingMigrations

public boolean isIgnorePendingMigrations()

setIgnorePendingMigrations

public void setIgnorePendingMigrations(boolean ignorePendingMigrations)

isIgnoreFutureMigrations

public boolean isIgnoreFutureMigrations()

setIgnoreFutureMigrations

public void setIgnoreFutureMigrations(boolean ignoreFutureMigrations)

isMixed
```
public boolean isMixed()
```

setMixed
```
public void setMixed(boolean mixed)
```

isOutOfOrder
```
public boolean isOutOfOrder()
```

setOutOfOrder

public void setOutOfOrder(boolean outOfOrder)

isSkipDefaultCallbacks

public boolean isSkipDefaultCallbacks()

setSkipDefaultCallbacks

public void setSkipDefaultCallbacks(boolean skipDefaultCallbacks)

isSkipDefaultResolvers

public boolean isSkipDefaultResolvers()

setSkipDefaultResolvers

public void setSkipDefaultResolvers(boolean skipDefaultResolvers)

isValidateMigrationNaming

public boolean isValidateMigrationNaming()

setValidateMigrationNaming

public void setValidateMigrationNaming(boolean validateMigrationNaming)

isValidateOnMigrate
```
public boolean isValidateOnMigrate()
```

setValidateOnMigrate

public void setValidateOnMigrate(boolean validateOnMigrate)

getBatch
```
public Boolean getBatch()
```

setBatch
```
public void setBatch(Boolean batch)
```

getDryRunOutput
```
public File getDryRunOutput()
```

setDryRunOutput

public void setDryRunOutput(File dryRunOutput)

getErrorOverrides
```
public String[] getErrorOverrides()
```

setErrorOverrides

public void setErrorOverrides(String[] errorOverrides)

getLicenseKey
```
public String getLicenseKey()
```

setLicenseKey

public void setLicenseKey(String licenseKey)

getOracleSqlplus
```
public Boolean getOracleSqlplus()
```

setOracleSqlplus

public void setOracleSqlplus(Boolean oracleSqlplus)

getOracleSqlplusWarn
```
public Boolean getOracleSqlplusWarn()
```

setOracleSqlplusWarn

public void setOracleSqlplusWarn(Boolean oracleSqlplusWarn)

getStream
```
public Boolean getStream()
```

setStream

public void setStream(Boolean stream)

getUndoSqlMigrationPrefix

public String getUndoSqlMigrationPrefix()

setUndoSqlMigrationPrefix

public void setUndoSqlMigrationPrefix(String undoSqlMigrationPrefix)

getCherryPick
```
public String[] getCherryPick()
```

setCherryPick

public void setCherryPick(String[] cherryPick)

getJdbcProperties

public Map<String,String> getJdbcProperties()

setJdbcProperties

public void setJdbcProperties(Map<String,String> jdbcProperties)

getOracleKerberosCacheFile

public String getOracleKerberosCacheFile()

setOracleKerberosCacheFile

public void setOracleKerberosCacheFile(String oracleKerberosCacheFile)

getOracleKerberosConfigFile

public String getOracleKerberosConfigFile()

setOracleKerberosConfigFile

public void setOracleKerberosConfigFile(String oracleKerberosConfigFile)

getOutputQueryResults

public Boolean getOutputQueryResults()

setOutputQueryResults

public void setOutputQueryResults(Boolean outputQueryResults)

getSkipExecutingMigrations

public Boolean getSkipExecutingMigrations()

setSkipExecutingMigrations

public void setSkipExecutingMigrations(Boolean skipExecutingMigrations)

getVaultUrl
```
public String getVaultUrl()
```

setVaultUrl

public void setVaultUrl(String vaultUrl)

getVaultToken
```
public String getVaultToken()
```

setVaultToken

public void setVaultToken(String vaultToken)

getVaultSecrets
```
public List<String> getVaultSecrets()
```

setVaultSecrets

public void setVaultSecrets(List<String> vaultSecrets)

Class FlywayProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FlywayProperties

Method Detail

isEnabled

setEnabled

isCheckLocation

setCheckLocation

getLocations

setLocations

getEncoding

setEncoding

getConnectRetries

setConnectRetries

getLockRetryCount

setLockRetryCount

getDefaultSchema

setDefaultSchema

getSchemas

setSchemas

isCreateSchemas

setCreateSchemas

getTable

setTable

getTablespace

setTablespace

getBaselineDescription

setBaselineDescription

getBaselineVersion

setBaselineVersion

getInstalledBy

setInstalledBy

getPlaceholders

setPlaceholders

getPlaceholderPrefix

setPlaceholderPrefix

getPlaceholderSuffix

setPlaceholderSuffix

isPlaceholderReplacement

setPlaceholderReplacement

getSqlMigrationPrefix

setSqlMigrationPrefix

getSqlMigrationSuffixes

setSqlMigrationSuffixes

getSqlMigrationSeparator

setSqlMigrationSeparator

getRepeatableSqlMigrationPrefix

setRepeatableSqlMigrationPrefix

getTarget

setTarget

isCreateDataSource

getUser

setUser

getPassword

setPassword

getDriverClassName

setDriverClassName

getUrl

setUrl

getInitSqls

setInitSqls

isBaselineOnMigrate

setBaselineOnMigrate

isCleanDisabled

setCleanDisabled

isCleanOnValidationError

setCleanOnValidationError

isGroup

setGroup

isIgnoreMissingMigrations

setIgnoreMissingMigrations

isIgnoreIgnoredMigrations

setIgnoreIgnoredMigrations

isIgnorePendingMigrations

setIgnorePendingMigrations

isIgnoreFutureMigrations

setIgnoreFutureMigrations