Package org.apache.openjpa.tools.maven

Class OpenJpaSqlMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    @Mojo(name="sql",
      defaultPhase=PROCESS_CLASSES,
      requiresDependencyResolution=COMPILE,
      threadSafe=true)
public class OpenJpaSqlMojo
extends AbstractOpenJpaMappingToolMojo
    Executes the SQL generation via the OpenJPA MappingTool.
    Since:
    1.0
    Version:
    $Id$

    • Field Detail

      • sqlAction

        @Parameter(defaultValue="build")
protected java.lang.String sqlAction
        The action to take for generating the SQL. Actions can be composed in a comma-separated list of one of the following items:
        • add (see MappingTool#ACTION_ADD)
        • refresh (see MappingTool#ACTION_REFRESH)
        • drop (see MappingTool#ACTION_DROP)
        • dropSchema (see MappingTool#ACTION_DROP_SCHEMA)
        • buildSchema (see MappingTool#ACTION_BUILD_SCHEMA)
        • import (see MappingTool#ACTION_IMPORT)
        • export (see MappingTool#ACTION_EXPORT)
        • validate (see MappingTool#ACTION_VALIDATE)
        Technically this is the same like the schemaAction, but we have to split it for the plugin to allow different actions for generating the mapping and generating the SQL files.

      • OPTION_SQL_ACTION

        protected static final java.lang.String OPTION_SQL_ACTION
        internally the options is named 'schemaAction'!
        See Also:
        Constant Field Values

      • sqlFile

        @Parameter(defaultValue="${project.build.directory}/database.sql")
protected java.io.File sqlFile
        Use this option to write the planned schema modifications to a SQL script. Combine this with a schemaAction of "build" to generate a script that recreates the schema for the current mappings, even if the schema already exists.

      • OPTION_SQL_FILE

        protected static final java.lang.String OPTION_SQL_FILE
        used for passing the sqlFile parameter to the mapping tool
        See Also:
        Constant Field Values

      • modifyDatabase

        @Parameter(defaultValue="false")
protected boolean modifyDatabase
        Use this option to write the planned schema modifications to the database. If this is set, the sqlFile setting (if any) will be ignored.

    • Constructor Detail

      • OpenJpaSqlMojo

        public OpenJpaSqlMojo()

    • Method Detail

      • getOptions

        protected Options getOptions()
                      throws org.apache.maven.plugin.MojoExecutionException
        Description copied from class: AbstractOpenJpaMojo
        Get the options for the various OpenJPA tools.
        Specified by:
        getOptions in class AbstractOpenJpaMojo
        Returns:
        Options filled with all necessary plugin parameters
        Throws:
        org.apache.maven.plugin.MojoExecutionException