ContextQMD
Back to Flyway

Maven Goal

documentation/Reference/Usage/Maven Goal.md

latest9.4 KB
Original Source

The Flyway Maven plugin supports Maven 3.x running on Java 17.

Installation

Flyway Community Edition

This includes Teams & Enterprise features subject to license.

<code>pom.xml</code>

<table class="table"> <tr> <td> <pre class="prettyprint">&lt;pluginRepositories&gt; ... &lt;pluginRepository&gt; &lt;id&gt;redgate&lt;/id&gt; &lt;url&gt;https://download.red-gate.com/maven/release&lt;/url&gt; &lt;/pluginRepository&gt; ... &lt;/pluginRepositories&gt; &lt;build&gt; ... &lt;plugin&gt; &lt;groupId&gt;<strong>com.redgate.flyway</strong>&lt;/groupId&gt; &lt;artifactId&gt;flyway-maven-plugin&lt;/artifactId&gt; &lt;version&gt;{{ site.flywayVersion }}&lt;/version&gt; &lt;/plugin&gt; ... &lt;/build&gt;</pre> </td> </tr> <tr> <td> By downloading Flyway Community Maven Plugin you confirm that you have read and agree to the terms of the <a href="https://www.red-gate.com/assets/purchase/assets/subscription-license.pdf?_ga=2.265045707.556964523.1656332792-1685764737.1620948215">Redgate EULA</a>. </td> </tr> </table>

To use Teams & Enterprise features, you will need the following plugin also

<table class="table"> <tr> <td> <pre class="prettyprint">&lt;build&gt; ... &lt;plugin&gt; &lt;groupId&gt;com.redgate.flyway&lt;/groupId&gt; &lt;artifactId&gt;flyway-redgate-licensing&lt;/artifactId&gt; &lt;version&gt;{{ site.flywayVersion }}&lt;/version&gt; &lt;/plugin&gt; ... &lt;/build&gt;</pre> </td> </tr> </table>

Please note, the groupId changed at Flyway V10.0.0 from org.flywaydb.enterprise to com.redgate.flyway and published as a convenience in both locations up till Flyway V10.22.0

For older versions see Accessing Older Versions of Flyway Engine

Open Source Edition

<code>pom.xml</code>

<table class="table"> <tr> <td> <pre class="prettyprint">&lt;build&gt; ... &lt;plugin&gt; &lt;groupId&gt;org.flywaydb&lt;/groupId&gt; &lt;artifactId&gt;flyway-maven-plugin&lt;/artifactId&gt; &lt;version&gt;{{ site.flywayVersion }}&lt;/version&gt; &lt;/plugin&gt; ... &lt;/build&gt;</pre> </td> </tr> </table>

Goals

<table class="table table-bordered table-hover"> <thead> <tr> <th><strong>Name</strong></th> <th><strong>Description</strong></th> </tr> </thead> <tbody> <tr> <td><a href="Commands/Migrate">migrate</a></td> <td>Migrates the database</td> </tr> <tr> <td><a href="Commands/Clean">clean</a></td> <td>Drops all objects in the configured schemas</td> </tr> <tr> <td><a href="Commands/Info">info</a></td> <td>Prints the details and status information about all the migrations</td> </tr> <tr> <td><a href="Commands/Validate">validate</a></td> <td>Validates the applied migrations against the ones available on the classpath</td> </tr> <tr> <td><a href="Commands/Undo">undo</a> {% include teams.html %}</td> <td>Undoes the most recently applied versioned migration</td> </tr> <tr> <td><a href="Commands/Baseline">baseline</a></td> <td>Baselines an existing database, excluding all migrations up to and including baselineVersion</td> </tr> <tr> <td><a href="Commands/Repair">repair</a></td> <td>Repairs the schema history table</td> </tr> </tbody> </table>

Configuration

The Flyway Maven plugin can be configured in a wide variety of following ways, which can all be combined at will.

Configuration section of the plugin

The easiest way is to simply use the plugin's configuration section in your pom.xml:

<pre class="prettyprint">&lt;plugin&gt; ... &lt;configuration&gt; &lt;user&gt;myUser&lt;/user&gt; &lt;password&gt;mySecretPwd&lt;/password&gt; &lt;schemas&gt; &lt;schema&gt;schema1&lt;/schema&gt; &lt;schema&gt;schema2&lt;/schema&gt; &lt;schema&gt;schema3&lt;/schema&gt; &lt;/schemas&gt; &lt;placeholders&gt; &lt;keyABC&gt;valueXYZ&lt;/keyABC&gt; &lt;otherplaceholder&gt;value123&lt;/otherplaceholder&gt; &lt;/placeholders&gt; &lt;/configuration&gt; &lt;/plugin&gt;</pre> <div class="well well-small"> <strong>Limitation: </strong> Due to a <a href="http://mail-archives.apache.org/mod_mbox/maven-users/200708.mbox/%[email protected]%3E">long standing Maven bug</a> it is <strong>not possible to configure empty values</strong> this way. You must use one of the other configurations ways instead. </div>

Maven properties

To make it easy to work with Maven profiles and to logically group configuration, the Flyway Maven plugin also supports Maven properties:

<pre class="prettyprint">&lt;project&gt; ... &lt;properties&gt; &lt;!-- Properties are prefixed with flyway. --&gt; &lt;flyway.user&gt;myUser&lt;/flyway.user&gt; &lt;flyway.password&gt;mySecretPwd&lt;/flyway.password&gt; &lt;!-- List are defined as comma-separated values --&gt; &lt;flyway.schemas&gt;schema1,schema2,schema3&lt;/flyway.schemas&gt; &lt;!-- Individual placeholders are prefixed by flyway.placeholders. --&gt; &lt;flyway.placeholders.keyABC&gt;valueXYZ&lt;/flyway.placeholders.keyABC&gt; &lt;flyway.placeholders.otherplaceholder&gt;value123&lt;/flyway.placeholders.otherplaceholder&gt; &lt;/properties&gt; ... &lt;/project&gt;</pre>

settings.xml

For storing the database user and password, Maven settings.xml files can also be used:

<pre class="prettyprint">&lt;settings&gt; &lt;servers&gt; &lt;server&gt; &lt;!-- By default Flyway will look for the server with the id 'flyway-db' --&gt; &lt;!-- This can be customized by configuring the 'serverId' property --&gt; &lt;id&gt;flyway-db&lt;/id&gt; &lt;username&gt;myUser&lt;/username&gt; &lt;password&gt;mySecretPwd&lt;/password&gt; &lt;/server&gt; &lt;/servers&gt; &lt;/settings&gt;</pre>

Both regular and encrypted settings files are supported.

Environment Variables

To make it easy to work with cloud and containerized environments, Flyway also supports configuration via environment variables.

System properties

Configuration can also be supplied directly via the command-line using JVM system properties:

<pre class="console"><span>&gt;</span> mvn -Dflyway.user=myUser -Dflyway.schemas=schema1,schema2 -Dflyway.placeholders.keyABC=valueXYZ</pre>

Config files

Config files are supported by the Flyway Maven plugin. If you are not familiar with them, check out the Flyway config file structure and settings reference first.

Flyway will search for and automatically load the <user-home>/flyway.conf config file if present.

It is also possible to point Flyway at one or more additional config files. This is achieved by supplying the System property flyway.configFiles as follows:

<pre class="console"><span>&gt;</span> mvn <strong>-Dflyway.configFiles=</strong>path/to/myAlternativeConfig.conf flyway:migrate</pre>

To pass in multiple files, separate their names with commas:

<pre class="console"><span>&gt;</span> mvn <strong>-Dflyway.configFiles</strong>=path/to/myAlternativeConfig.conf,other.conf flyway:migrate</pre>

Relative paths are relative to the directory containing your pom.xml file.

Alternatively you can also use the FLYWAY_CONFIG_FILES environment variable for this. When set it will take preference over the command-line parameter.

<pre class="console"><span>&gt;</span> export <strong>FLYWAY_CONFIG_FILES</strong>=path/to/myAlternativeConfig.conf,other.conf</pre>

By default Flyway loads configuration files using UTF-8. To use an alternative encoding, pass the system property <code>flyway.configFileEncoding</code> as follows:

<pre class="console"><span>&gt;</span> mvn <strong>-Dflyway.configFileEncoding=</strong>ISO-8859-1 flyway:migrate</pre>

This is also possible via the configuration section of the plugin or Maven properties, as described above.

Alternatively you can also use the FLYWAY_CONFIG_FILE_ENCODING environment variable for this. When set it will take preference over the command-line parameter.

<pre class="console"><span>&gt;</span> export <strong>FLYWAY_CONFIG_FILE_ENCODING</strong>=ISO-8859-1</pre>

Overriding order

The Flyway Maven plugin has been carefully designed to load and override configuration in a sensible order.

Settings are loaded in the following order (higher items in the list take precedence over lower ones):

  1. System properties
  2. Environment variables
  3. Custom config files
  4. Maven properties
  5. Plugin configuration section
  6. Credentials from settings.xml
  7. <user-home>/flyway.conf
  8. Flyway Maven plugin defaults

The means that if for example flyway.url is both present in a config file and passed as -Dflyway.url= from the command-line, the JVM system property passed in via the command-line will take precedence and be used.