Built by Maven

migration:new

Full name:

org.mybatis.maven:migrations-maven-plugin:1.2.0:new

Description:

Goal which executes the ibatis migration new command.

Attributes:

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

Required Parameters

Name Type Since Description
<description> String - New file description.
User Property: migration.description

Optional Parameters

Name Type Since Description
<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
<idPattern> String - Sequential number for script prefix. (type 000 to generate 001_create_changelog)
User Property: migration.idpattern
<repository> File - Location of migrate repository.
Default: .
User Property: migration.path
<skip> boolean - Skip migration actions.
Default: false
User Property: migration.skip
<template> String - New file based on template.
User Property: migration.template

Parameter Details

<description>

New file description.
  • Type: java.lang.String
  • Required: Yes
  • User Property: migration.description

<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

<idPattern>

Sequential number for script prefix. (type 000 to generate 001_create_changelog)
  • Type: java.lang.String
  • Required: No
  • User Property: migration.idpattern

<repository>

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

<skip>

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

<template>

New file based on template.
  • Type: java.lang.String
  • Required: No
  • User Property: migration.template