Built by Maven

migration:status-report

Note:

This goal should be used as a Maven report.

Full name:

org.mybatis.maven:migrations-maven-plugin:1.2.0:status-report

Description:

Extends org.apache.maven.reporting.AbstractMavenReport.
Class to generate a Maven report.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is not marked as thread-safe and thus does not support parallel builds.
  • Since version: 2.0.

Optional Parameters

Name Type Since Description
<aggregate> boolean - Aggregate report results.
Default: false
User Property: migration.aggregate
<environment> String - Environment to configure. Default environment is 'development'.
Default: development
User Property: migration.env
<force> boolean - Forces script to continue even if SQL errors are encountered.
Default: false
User Property: migration.force
<locale> String - The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)
Default: default
<outputFormat> String - The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
User Property: output.format
<outputTimestamp> String - Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
Default: ${project.build.outputTimestamp}
<repository> File - Location of migrate repository.
Default: .
User Property: migration.path
<siteDirectory> File - Directory containing the site.xml file.
Default: ${basedir}/src/site
<skip> boolean - Skip migration actions.
Default: false
User Property: migration.skip

Parameter Details

<aggregate>

Aggregate report results.
  • Type: boolean
  • Required: No
  • User Property: migration.aggregate
  • Default: false

<environment>

Environment to configure. Default environment is 'development'.
  • Type: java.lang.String
  • Required: No
  • User Property: migration.env
  • Default: development

<force>

Forces script to continue even if SQL errors are encountered.
  • Type: boolean
  • Required: No
  • User Property: migration.force
  • Default: false

<locale>

The locale to use when the report generation is invoked directly as a standalone Mojo.
See also: org.apache.maven.doxia.tools.SiteTool.DEFAULT_LOCALE, org.apache.maven.doxia.tools.SiteTool.getSiteLocales(java.lang.String)
  • Type: java.lang.String
  • Required: No
  • Default: default

<outputFormat>

The report output format: null by default, to represent a site, but can be configured to a Doxia Sink id.
  • Type: java.lang.String
  • Required: No
  • User Property: output.format

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.outputTimestamp}

<repository>

Location of migrate repository.
  • Type: java.io.File
  • Required: No
  • User Property: migration.path
  • Default: .

<siteDirectory>

Directory containing the site.xml file.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/site

<skip>

Skip migration actions.
  • Type: boolean
  • Required: No
  • User Property: migration.skip
  • Default: false