liquibase:tag

Full name:

org.liquibase:liquibase-maven-plugin:3.5.0-SNAPSHOT:tag

Description:

Writes a Liquibase tag to the database.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: test.

Required Parameters

Name Type Since Description
tag String - (no description)

Optional Parameters

Name Type Since Description
changelogCatalogName String - Schema against which Liquibase changelog tables will be created.
changelogSchemaName String - Schema against which Liquibase changelog tables will be created.
clearCheckSums boolean - Flag for forcing the checksums to be cleared from teh DatabaseChangeLog table.
Default value is: false.
databaseChangeLogLockTableName String - Table name to use for the databasechangelog.
databaseChangeLogTableName String - Table name to use for the databasechangelog.
databaseClass String - The class to use as the database object.
defaultCatalogName String - The default catalog name to use the for database connection.
defaultSchemaName String - The default schema name to use the for database connection.
driver String - The fully qualified name of the driver class to use to connect to the database.
driverPropertiesFile File - Location of a properties file containing JDBC connection properties for use by the driver.
emptyPassword boolean - Deprecated. Use an empty or null value for the password instead.
Default value is: false.
expressionVariables Map - Array to put a expression variable to maven plugin.
expressionVars Properties - Array to put a expression variable to maven plugin.
includeArtifact boolean - Allows for the maven project artifact to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.
Default value is: true.
includeTestOutputDirectory boolean - Allows for the maven test output directory to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.
Default value is: true.
logging String - Controls the level of logging from Liquibase when executing. The value can be "debug", "info", "warning", "severe", or "off". The value is case insensitive.
Default value is: INFO.
outputDefaultCatalog boolean - Whether to ignore the catalog/database name.
outputDefaultSchema boolean - Whether to ignore the schema name.
outputFileEncoding String - Flag to set the character encoding of the output file produced by Liquibase during the updateSQL phase.
password String - The database password to use to connect to the specified database.
promptOnNonLocalDatabase boolean - Controls the prompting of users as to whether or not they really want to run the changes on a database that is not local to the machine that the user is current executing the plugin on.
Default value is: true.
propertyFile String - The Liquibase properties file used to configure the Liquibase Liquibase.
propertyFileWillOverride boolean - Flag allowing for the Liquibase properties file to override any settings provided in the Maven plugin configuration. By default if a property is explicity specified it is not overridden if it also appears in the properties file.
Default value is: false.
propertyProviderClass String - The class to use as the property provider (must be a java.util.Properties implementation).
server String - The server id in settings.xml to use when authenticating with.
skip boolean - Set this to 'false' to skip running liquibase. Its use is NOT RECOMMENDED, but quite convenient on occasion.
systemProperties Properties - List of system properties to pass to the database.
url String - The Database URL to connect to for executing Liquibase.
username String - The database username to use to connect to the specified database.
verbose boolean - Controls the verbosity of the output from invoking the plugin.
Default value is: false.

Parameter Details

changelogCatalogName:

Schema against which Liquibase changelog tables will be created.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.changelogCatalogName}

changelogSchemaName:

Schema against which Liquibase changelog tables will be created.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.changelogSchemaName}

clearCheckSums:

Flag for forcing the checksums to be cleared from teh DatabaseChangeLog table.
  • Type: boolean
  • Required: No
  • Expression: ${liquibase.clearCheckSums}
  • Default: false

databaseChangeLogLockTableName:

Table name to use for the databasechangelog.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.databaseChangeLogLockTableName}

databaseChangeLogTableName:

Table name to use for the databasechangelog.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.databaseChangeLogTableName}

databaseClass:

The class to use as the database object.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.databaseClass}

defaultCatalogName:

The default catalog name to use the for database connection.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.defaultCatalogName}

defaultSchemaName:

The default schema name to use the for database connection.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.defaultSchemaName}

driver:

The fully qualified name of the driver class to use to connect to the database.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.driver}

driverPropertiesFile:

Location of a properties file containing JDBC connection properties for use by the driver.
  • Type: java.io.File
  • Required: No

emptyPassword:

Deprecated. Use an empty or null value for the password instead.
Use an empty string as the password for the database connection. This should not be used along side the password setting.
  • Type: boolean
  • Required: No
  • Expression: ${liquibase.emptyPassword}
  • Default: false

expressionVariables:

Array to put a expression variable to maven plugin.
  • Type: java.util.Map
  • Required: No

expressionVars:

Array to put a expression variable to maven plugin.
  • Type: java.util.Properties
  • Required: No

includeArtifact:

Allows for the maven project artifact to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.
  • Type: boolean
  • Required: No
  • Expression: ${liquibase.includeArtifact}
  • Default: true

includeTestOutputDirectory:

Allows for the maven test output directory to be included in the class loader for obtaining the Liquibase property and DatabaseChangeLog files.
  • Type: boolean
  • Required: No
  • Expression: ${liquibase.includeTestOutputDirectory}
  • Default: true

logging:

Controls the level of logging from Liquibase when executing. The value can be "debug", "info", "warning", "severe", or "off". The value is case insensitive.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.logging}
  • Default: INFO

outputDefaultCatalog:

Whether to ignore the catalog/database name.
  • Type: boolean
  • Required: No
  • Expression: ${liquibase.outputDefaultCatalog}

outputDefaultSchema:

Whether to ignore the schema name.
  • Type: boolean
  • Required: No
  • Expression: ${liquibase.outputDefaultSchema}

outputFileEncoding:

Flag to set the character encoding of the output file produced by Liquibase during the updateSQL phase.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.outputFileEncoding}

password:

The database password to use to connect to the specified database.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.password}

promptOnNonLocalDatabase:

Controls the prompting of users as to whether or not they really want to run the changes on a database that is not local to the machine that the user is current executing the plugin on.
  • Type: boolean
  • Required: No
  • Expression: ${liquibase.promptOnNonLocalDatabase}
  • Default: true

propertyFile:

The Liquibase properties file used to configure the Liquibase Liquibase.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.propertyFile}

propertyFileWillOverride:

Flag allowing for the Liquibase properties file to override any settings provided in the Maven plugin configuration. By default if a property is explicity specified it is not overridden if it also appears in the properties file.
  • Type: boolean
  • Required: No
  • Expression: ${liquibase.propertyFileWillOverride}
  • Default: false

propertyProviderClass:

The class to use as the property provider (must be a java.util.Properties implementation).
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.propertyProviderClass}

server:

The server id in settings.xml to use when authenticating with.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.server}

skip:

Set this to 'false' to skip running liquibase. Its use is NOT RECOMMENDED, but quite convenient on occasion.
  • Type: boolean
  • Required: No
  • Expression: ${liquibase.skip}

systemProperties:

List of system properties to pass to the database.
  • Type: java.util.Properties
  • Required: No

tag:

(no description)
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${liquibase.tag}

url:

The Database URL to connect to for executing Liquibase.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.url}

username:

The database username to use to connect to the specified database.
  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.username}

verbose:

Controls the verbosity of the output from invoking the plugin.
  • Type: boolean
  • Required: No
  • Expression: ${liquibase.verbose}
  • Default: false