org.apache.torque.mojo
Class SchemaSqlMojo

java.lang.Object
  org.apache.maven.plugin.AbstractMojo
      org.apache.torque.mojo.BaseMojo
          org.apache.torque.mojo.AntTaskMojo
              org.apache.torque.mojo.TexenTaskMojo
                  org.apache.torque.mojo.DataModelTaskMojo
                      org.apache.torque.mojo.SqlMojoBase
                          org.apache.torque.mojo.SchemaSqlMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class SchemaSqlMojo
extends SqlMojoBase

Generates platform specific SQL from database agnostic XML files.

There are two types of SQL files created by this goal:

Type 1: DDL statements for creating tables, primary keys, indexes, and unique constraints. Does not contain DDL for enforcing relationships between tables.
Type 2: DDL statements for creating and enforcing relationships between tables

This allows data to be imported into multiple tables concurrently. Running the first type of SQL file will create the empty tables without any foreign key constraints. Data can then be loaded concurrently into the tables (using optimized high speed tools if desired) without needing to worry about the order in which the tables are loaded. After data has been loaded, the second type of SQL file can be run to add the relationships between the tables. As long as the data set is consistent and correct, all the relationships will get created correctly.

The database platform to generate SQL for is determined by ${targetDatabase}. See also impex:datasql

Field Summary

private String	dummy1 The directory in which the SQL will be generated.
private String	dummy2 The location where the report file will be generated.
private String	dummy3 The location where the context property file for velocity will be generated.
private String	dummy4 The suffix of the generated sql files.

Fields inherited from class org.apache.torque.mojo.DataModelTaskMojo

suffix, TARGET_DATABASE_CONTEXT_PROPERTY, url

Fields inherited from class org.apache.torque.mojo.BaseMojo

FS, SKIP_PACKAGING_TYPE

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

ROLE

Constructor Summary

SchemaSqlMojo()

Method Summary

void	executeMojo() Generate SQL from schema XML files
protected void	showConfig()

Methods inherited from class org.apache.torque.mojo.SqlMojoBase

configureTask, getControlTemplate, getMojoContextProperties

Methods inherited from class org.apache.torque.mojo.DataModelTaskMojo

addTargetDatabaseToOutputDir, addTargetDatabaseToReportFile, getAntFileSet, getCanonicalReportFile, getInvalidTargetDatabaseMessage, getReportFile, getSchemaDir, getSchemaExcludes, getSchemaFiles, getSchemaIncludes, getSqlDbMap, getSuffix, getTargetDatabase, getTargetPackage, getUrl, isRunOnlyOnSchemaChange, setReportFile, setRunOnlyOnSchemaChange, setSchemaDir, setSchemaExcludes, setSchemaIncludes, setSqlDbMap, setSuffix, setTargetDatabase, setTargetPackage, setUrl, updateConfiguration, validateConfiguration

Methods inherited from class org.apache.torque.mojo.TexenTaskMojo

generateContextProperties, getContextPropertiesPath, getGeneratorTask, getOutputDir, getTemplatePath, getUseClasspath, getUserContextProperties, setContextPropertiesPath, setOutputDir, setTemplatePath, setUseClasspath, setUserContextProperties

Methods inherited from class org.apache.torque.mojo.AntTaskMojo

getAntProject, getAntTask, getIniatializedAntProject, setAntProject, setAntTask

Methods inherited from class org.apache.torque.mojo.BaseMojo

afterExecution, beforeExecution, execute, getEncoding, getMavenSession, getProject, getSettings, isForceMojoExecution, isSkip, isStartMavenLogger, setEncoding, setForceMojoExecution, setMavenSession, setProject, setSettings, setSkip, setStartMavenLogger, skipMojo

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

Field Detail

dummy1

private String dummy1

The directory in which the SQL will be generated.

dummy2

private String dummy2

The location where the report file will be generated.

dummy3

private String dummy3

The location where the context property file for velocity will be generated.

dummy4

private String dummy4

The suffix of the generated sql files.

Constructor Detail

SchemaSqlMojo

public SchemaSqlMojo()

Method Detail

showConfig

protected void showConfig()

executeMojo

public void executeMojo()
                 throws org.apache.maven.plugin.MojoExecutionException

Generate SQL from schema XML files

Overrides:

executeMojo in class TexenTaskMojo

Throws:

org.apache.maven.plugin.MojoExecutionException - if an error occurs during execution.

See Also:

Mojo.execute()