Package org.flywaydb.maven

Class MigrateMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="migrate",
      requiresDependencyResolution=TEST,
      defaultPhase=PRE_INTEGRATION_TEST,
      threadSafe=true)
public class MigrateMojo
extends org.apache.maven.plugin.AbstractMojo
    Maven goal that triggers the migration of the configured database to the latest version.

    • Field Summary

      • Fields inherited from interface org.apache.maven.plugin.Mojo

        ROLE

    • Constructor Summary

      Constructors 
      Constructor Description
      MigrateMojo()  

    • Method Summary

      Modifier and Type Method Description
      protected void doExecute​(org.flywaydb.core.Flyway flyway)
      Executes this mojo.
      void execute()  
      protected java.lang.String getProperty​(java.lang.String name)
      Retrieves this property from either the system or the maven properties.

      • Methods inherited from class org.apache.maven.plugin.AbstractMojo

        getLog, getPluginContext, setLog, setPluginContext

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MigrateMojo

        public MigrateMojo()

    • Method Detail

      • doExecute

        protected void doExecute​(org.flywaydb.core.Flyway flyway)
                  throws java.lang.Exception
        Executes this mojo.
        Parameters:
        flyway - The flyway instance to operate on.
        Throws:
        java.lang.Exception - any exception

      • execute

        public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException
        Throws:
        org.apache.maven.plugin.MojoExecutionException

      • getProperty

        protected java.lang.String getProperty​(java.lang.String name)
        Retrieves this property from either the system or the maven properties.
        Parameters:
        name - The name of the property to retrieve.
        Returns:
        The property value. null if not found.