Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal Report? Description
migration:bootstrap No Goal which execute the ibatis migration bootstrap command.
migration:check No Goal which check the presence of pending migration.
migration:down No Goal which execute the ibatis migration status command.
migration:help No Display help information on migrations-maven-plugin.
Call mvn migration:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
migration:init No Goal which executes the MyBatis migration init command.

Init command creates a new migrate repository into 'repository' location.

migration:new No Goal which executes the ibatis migration new command.
migration:pending No Goal which execute the ibatis migration pending command.
migration:redo No Goal which execute the ibatis migration redo command.
migration:script No Goal which executes the ibatis migration script command.
migration:status No Goal which execute the ibatis migration status command.
migration:status-report Yes Extends org.apache.maven.reporting.AbstractMavenReport.
Class to generate a Maven report.
migration:up No Goal which execute the ibatis migration status command.
migration:version No Goal which execute the ibatis migration version command.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.9.8
JDK 1.8

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version Maven JDK
from 1.1.4 to 1.6.0 - 8
1.1.3 - 6
from 1.1.0 to 1.1.2 - 5

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.mybatis.maven</groupId>
          <artifactId>migrations-maven-plugin</artifactId>
          <version>1.2.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.mybatis.maven</groupId>
        <artifactId>migrations-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.mybatis.maven</groupId>
        <artifactId>migrations-maven-plugin</artifactId>
        <version>1.2.0</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"