Translations of this page?:

liquibase:migrate

Full name:

org.liquibase:liquibase-plugin:1.7.0.0-SNAPSHOT:migrate

Description:

Liquibase Migration Maven plugin. This plugin allows for DatabaseChangeLogs to be applied to a database as part of a Maven build process.

Attributes:

  • This plugin goal has been deprecated: Use the LiquibaseUpdate class or Maven goal "update" instead..
  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: test.

Optional Parameters

Name Type Since Description
changeLogFile String - Specifies the change log file to use for Liquibase.
changesToApply int - The number of changes to apply to the database. By default this value is 0, which will result in all changes (not already applied to the database) being applied. Default value is: 0.
clearCheckSums boolean - Flag for forcing the checksums to be cleared from teh DatabaseChangeLog table. Default value is: false.
contexts String - The Liquibase contexts to execute, which can be "," separated if multiple contexts are required. If no context is specified then ALL contexts will be executed.
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.
dropFirst boolean - Whether or not to perform a drop on the database before executing the change. Default value is: false.
emptyPassword boolean - Deprecated. Use an empty string as the password for the database connection. This should not be used along side the password setting. Default value is: false.
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.
logging String - Controls the level of logging from Liquibase when executing. The value can be "all", "finest", "finer", "fine", "info", "warning", "severe" or "off". The value is case insensitive. Default value is: INFO.
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.
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

changeLogFile :

Specifies the change log file to use for Liquibase.

  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.changeLogFile}

changesToApply :

The number of changes to apply to the database. By default this value is 0, which will result in all changes (not already applied to the database) being applied.

  • Type: int
  • Required: No
  • Expression: ${liquibase.changesToApply}
  • Default: 0

clearCheckSums :

Flag for forcing the checksums to be cleared from teh DatabaseChangeLog table.

  • Type: boolean
  • Required: No
  • Expression: ${liquibase.clearCheckSums}
  • Default: false

contexts :

The Liquibase contexts to execute, which can be "," separated if multiple contexts are required. If no context is specified then ALL contexts will be executed.

  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.contexts}

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}

dropFirst :

Whether or not to perform a drop on the database before executing the change.

  • Type: boolean
  • Required: No
  • Expression: ${liquibase.dropFirst}
  • Default: false

emptyPassword :

Use an empty string as the password for the database connection. This should not be used along side the password setting.

  • Deprecated: Use an empty or null value for the password instead.
  • Type: boolean
  • Required: No
  • Expression: ${liquibase.emptyPassword}
  • Default: false

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

logging :

Controls the level of logging from Liquibase when executing. The value can be "all", "finest", "finer", "fine", "info", "warning", "severe" or "off". The value is case insensitive.

  • Type: java.lang.String
  • Required: No
  • Expression: ${liquibase.logging}
  • Default: INFO

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

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

 
manual/maven_migrate.txt · Last modified: 2008/03/18 07:08 (external edit)     Back to top