LiquibaseConfigurationProperties (micronaut-configuration-liquibase 1.1.0 API)

java.lang.Object
- io.micronaut.configuration.dbmigration.liquibase.LiquibaseConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable
```
@EachProperty(value="liquibase.datasources")
public class LiquibaseConfigurationProperties
extends java.lang.Object
implements io.micronaut.core.util.Toggleable
```
Create a Liquibase Configuration for each sub-property of liquibase.datasources.*.

Since:

1.0.0

Author:

Sergio del Amo

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_ASYNC` The default async value.
`static boolean`	`DEFAULT_DROPFIRST` The default dropFirst value.
`static boolean`	`DEFAULT_ENABLED` The default enable value.
`static boolean`	`DEFAULT_IGNORECLASSPATHPREFIX` The default ignoreClasspathPrefix value.
`static boolean`	`DEFAULT_TESTROLLBACKONUPDATE` The default testRollbackOnUpdate value.

Constructor Summary

Constructors
Constructor and Description

LiquibaseConfigurationProperties(java.lang.String name)

Constructors
Constructor and Description
`LiquibaseConfigurationProperties(java.lang.String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getChangeLog()`
`java.lang.String`	`getContexts()` Comma-separated list of runtime contexts to use.
`java.lang.String`	`getDatabaseChangeLogLockTable()` Name of table to use for tracking concurrent Liquibase usage.
`java.lang.String`	`getDatabaseChangeLogTable()` Name of table to use for tracking change history.
`java.lang.String`	`getDefaultSchema()`
`java.lang.String`	`getLabels()` Comma-separated list of runtime labels to use.
`java.lang.String`	`getLiquibaseSchema()` Schema to use for Liquibase objects.
`java.lang.String`	`getLiquibaseTablespace()` Tablespace to use for Liquibase objects.
`java.lang.String`	`getNameQualifier()`
`java.util.Map<java.lang.String,java.lang.String>`	`getParameters()`
`java.io.File`	`getRollbackFile()`
`java.lang.String`	`getRollbackFilePath()`
`java.lang.String`	`getTag()`
`boolean`	`isAsync()`
`boolean`	`isDropFirst()`
`boolean`	`isEnabled()`
`boolean`	`isIgnoreClasspathPrefix()`
`boolean`	`isTestRollbackOnUpdate()` Returns whether a rollback should be tested at update time or not.
`void`	`setAsync(boolean async)` Whether liquibase operations should be run asynchronously.
`void`	`setChangeLog(java.lang.String changeLog)` Change log configuration path.
`void`	`setContexts(java.lang.String contexts)` Comma-separated list of runtime contexts to use.
`void`	`setDatabaseChangeLogLockTable(java.lang.String databaseChangeLogLockTable)` Name of table to use for tracking concurrent Liquibase usage.
`void`	`setDatabaseChangeLogTable(java.lang.String databaseChangeLogTable)` Name of table to use for tracking change history.
`void`	`setDefaultSchema(java.lang.String defaultSchema)` Default database schema.
`void`	`setDropFirst(boolean dropFirst)` Whether to first drop the database schema.
`void`	`setEnabled(boolean enabled)` Sets whether this liquibase configuration is enabled.
`void`	`setIgnoreClasspathPrefix(boolean ignoreClasspathPrefix)` Ignores classpath prefix during changeset comparison.
`void`	`setLabels(java.lang.String labels)` Comma-separated list of runtime labels to use.
`void`	`setLiquibaseSchema(java.lang.String liquibaseSchema)` Schema to use for Liquibase objects.
`void`	`setLiquibaseTablespace(java.lang.String liquibaseTablespace)` Tablespace to use for Liquibase objects.
`void`	`setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)` Change log parameters.
`void`	`setRollbackFilePath(java.lang.String rollbackFilePath)` Path to file to which rollback SQL is written when an update is performed.
`void`	`setTag(java.lang.String tag)`
`void`	`setTestRollbackOnUpdate(boolean testRollbackOnUpdate)` Whether rollback should be tested before update is performed.

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

- Field Detail
  - DEFAULT_ENABLED
```
public static final boolean DEFAULT_ENABLED
```
    The default enable value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DROPFIRST
```
public static final boolean DEFAULT_DROPFIRST
```
    The default dropFirst value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TESTROLLBACKONUPDATE
```
public static final boolean DEFAULT_TESTROLLBACKONUPDATE
```
    The default testRollbackOnUpdate value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IGNORECLASSPATHPREFIX
```
public static final boolean DEFAULT_IGNORECLASSPATHPREFIX
```
    The default ignoreClasspathPrefix value.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ASYNC
```
public static final boolean DEFAULT_ASYNC
```
    The default async value.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - LiquibaseConfigurationProperties
```
public LiquibaseConfigurationProperties(@Parameter
                                        java.lang.String name)
```
    Parameters:
    
    name - name qualifier.
- Method Detail
  - setTestRollbackOnUpdate
```
public void setTestRollbackOnUpdate(boolean testRollbackOnUpdate)
```
    Whether rollback should be tested before update is performed. Default value (false).
    
    Parameters:
    
    testRollbackOnUpdate - Whether rollback should be tested before update is performed.
  - isTestRollbackOnUpdate
```
public boolean isTestRollbackOnUpdate()
```
    Returns whether a rollback should be tested at update time or not.
    
    Returns:
    
    Whether a rollback should be tested at update time or not.
  - isIgnoreClasspathPrefix
```
public boolean isIgnoreClasspathPrefix()
```
    Returns:
    
    true if classpath prefix should be ignored during changeset comparison
  - setIgnoreClasspathPrefix
```
public void setIgnoreClasspathPrefix(boolean ignoreClasspathPrefix)
```
    Ignores classpath prefix during changeset comparison. Default value (true).
    
    Parameters:
    
    ignoreClasspathPrefix - Sets whether to ignore the classpath prefix during changeset comparison.
  - getDatabaseChangeLogLockTable
```
public java.lang.String getDatabaseChangeLogLockTable()
```
    Name of table to use for tracking concurrent Liquibase usage.
    
    Returns:
    
    the name of table to use for tracking concurrent Liquibase usage.
  - setDatabaseChangeLogLockTable
```
public void setDatabaseChangeLogLockTable(java.lang.String databaseChangeLogLockTable)
```
    Name of table to use for tracking concurrent Liquibase usage.
    
    Parameters:
    
    databaseChangeLogLockTable - the name of table to use for tracking concurrent Liquibase usage.
  - getDatabaseChangeLogTable
```
public java.lang.String getDatabaseChangeLogTable()
```
    Name of table to use for tracking change history.
    
    Returns:
    
    the name of table to use for tracking change history.
  - setDatabaseChangeLogTable
```
public void setDatabaseChangeLogTable(java.lang.String databaseChangeLogTable)
```
    Name of table to use for tracking change history.
    
    Parameters:
    
    databaseChangeLogTable - the name of table to use for tracking change history.
  - getLiquibaseTablespace
```
public java.lang.String getLiquibaseTablespace()
```
    Tablespace to use for Liquibase objects.
    
    Returns:
    
    the tablespace to use for Liquibase objects.
  - setLiquibaseTablespace
```
public void setLiquibaseTablespace(java.lang.String liquibaseTablespace)
```
    Tablespace to use for Liquibase objects.
    
    Parameters:
    
    liquibaseTablespace - the tablespace to use for Liquibase objects.
  - getLiquibaseSchema
```
public java.lang.String getLiquibaseSchema()
```
    Schema to use for Liquibase objects.
    
    Returns:
    
    Schema to use for Liquibase objects.
  - setLiquibaseSchema
```
public void setLiquibaseSchema(java.lang.String liquibaseSchema)
```
    Schema to use for Liquibase objects.
    
    Parameters:
    
    liquibaseSchema - Schema to use for Liquibase objects.
  - getChangeLog
```
public java.lang.String getChangeLog()
```
    Returns:
    
    the liquibase changelog
  - setChangeLog
```
public void setChangeLog(java.lang.String changeLog)
```
    Change log configuration path.
    
    Parameters:
    
    changeLog - sets the change log configuration path.
  - setRollbackFilePath
```
public void setRollbackFilePath(java.lang.String rollbackFilePath)
```
    Path to file to which rollback SQL is written when an update is performed.
    
    Parameters:
    
    rollbackFilePath - Path to file to which rollback SQL is written when an update is performed.
  - getRollbackFilePath
```
public java.lang.String getRollbackFilePath()
```
    Returns:
    
    the path to file to which rollback SQL is written when an update is performed.
  - getRollbackFile
```
public java.io.File getRollbackFile()
```
    Returns:
    
    the file to which rollback SQL is written when an update is performed.
  - isDropFirst
```
public boolean isDropFirst()
```
    Returns:
    
    true if database schema should be drop before running liquibase operations.
  - setDropFirst
```
public void setDropFirst(boolean dropFirst)
```
    Whether to first drop the database schema. Default value (false).
    
    Parameters:
    
    dropFirst - True to drop the schema.
  - getDefaultSchema
```
public java.lang.String getDefaultSchema()
```
    Returns:
    
    the default database schema.
  - setDefaultSchema
```
public void setDefaultSchema(java.lang.String defaultSchema)
```
    Default database schema.
    
    Parameters:
    
    defaultSchema - Sets the default database schema.
  - getParameters
```
public java.util.Map<java.lang.String,java.lang.String> getParameters()
```
    Returns:
    
    the change log parameters.
  - setParameters
```
public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
```
    Change log parameters.
    
    Parameters:
    
    parameters - Change log parameters
  - getTag
```
public java.lang.String getTag()
```
    Returns:
    
    the liquibase tag.
  - setTag
```
public void setTag(java.lang.String tag)
```
    Parameters:
    
    tag - a tag.
  - getContexts
```
public java.lang.String getContexts()
```
    Comma-separated list of runtime contexts to use.
    
    Returns:
    
    a comma-separated list of runtime contexts to use.
  - setContexts
```
public void setContexts(java.lang.String contexts)
```
    Comma-separated list of runtime contexts to use.
    
    Parameters:
    
    contexts - a comma-separated list of runtime contexts to use.
  - getLabels
```
public java.lang.String getLabels()
```
    Comma-separated list of runtime labels to use.
    
    Returns:
    
    A Comma-separated list of runtime labels to use
  - setLabels
```
public void setLabels(java.lang.String labels)
```
    Comma-separated list of runtime labels to use.
    
    Parameters:
    
    labels - A Comma-separated list of runtime labels to use
  - isEnabled
```
public boolean isEnabled()
```
    Specified by:
    
    isEnabled in interface io.micronaut.core.util.Toggleable
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Sets whether this liquibase configuration is enabled. Default value (true).
    
    Parameters:
    
    enabled - True if it is enabled
  - getNameQualifier
```
public java.lang.String getNameQualifier()
```
    Returns:
    
    name qualifier associated with this liquibase configuration.
  - setAsync
```
public void setAsync(boolean async)
```
    Whether liquibase operations should be run asynchronously.
    
    Parameters:
    
    async - true to run liquibase operations asynchronously
  - isAsync
```
public boolean isAsync()
```
    Returns:
    
    true if liquibase operations should be run asynchronously.

Class LiquibaseConfigurationProperties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ENABLED

DEFAULT_DROPFIRST

DEFAULT_TESTROLLBACKONUPDATE

DEFAULT_IGNORECLASSPATHPREFIX

DEFAULT_ASYNC

Constructor Detail

LiquibaseConfigurationProperties

Method Detail

setTestRollbackOnUpdate

isTestRollbackOnUpdate

isIgnoreClasspathPrefix

setIgnoreClasspathPrefix

getDatabaseChangeLogLockTable

setDatabaseChangeLogLockTable

getDatabaseChangeLogTable

setDatabaseChangeLogTable

getLiquibaseTablespace

setLiquibaseTablespace

getLiquibaseSchema

setLiquibaseSchema

getChangeLog

setChangeLog

setRollbackFilePath

getRollbackFilePath

getRollbackFile

isDropFirst

setDropFirst

getDefaultSchema

setDefaultSchema

getParameters

setParameters

getTag

setTag

getContexts

setContexts

getLabels

setLabels

isEnabled

setEnabled

getNameQualifier

setAsync

isAsync