Added: db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/datasql-mojo.html URL: http://svn.apache.org/viewvc/db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/datasql-mojo.html?rev=1396951&view=auto ============================================================================== --- db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/datasql-mojo.html (added) +++ db/torque/site-scmpublish/torque-3.3/releases/torque-3.3/maven2-plugin/datasql-mojo.html Thu Oct 11 08:51:09 2012 @@ -0,0 +1,409 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> + + + + + + + + + + + +<html xmlns="http://www.w3.org/1999/xhtml";> + <head> + <title>Torque Maven2 Plugin - torque:datasql</title> + <style type="text/css" media="all"> + @import url("./css/maven-base.css"); + @import url("./css/maven-theme.css"); + @import url("./css/site.css"); + </style> + <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> + <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" /> + </head> + <body class="composite"> + <div id="banner"> + <a href="../../" id="bannerLeft"> + + <img src="../images/db-logo-white.png" alt="" /> + + </a> + <span id="bannerRight"> + + <img src="../images/torque-logo-new.png" alt="" /> + + </span> + <div class="clear"> + <hr/> + </div> + </div> + <div id="breadcrumbs"> + + + + + + + + + <div class="xleft"> + Last Published: 2012-10-11 + | Version: 3.3.1-SNAPSHOT + </div> + <div class="xright"> <a href="http://www.apache.org/"; class="externalLink">Apache</a> + | + <a href="../../">DB</a> + | + <a href="..">Torque</a> + + + + + + + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + <div id="leftColumn"> + <div id="navcolumn"> + + + + + + + + + <h5>Goals</h5> + <ul> + + <li class="none"> + <a href="plugin-info.html">Goals</a> + </li> + + <li class="none"> + <a href="usage.html">Usage</a> + </li> + </ul> + <h5>Project Documentation</h5> + <ul> + + + + + + + + + + + + + + + + + + + + + + + + + + <li class="collapsed"> + <a href="project-info.html">Project Information</a> + </li> + + + + + + + + + + + + + + + + + + + + + + + + + + <li class="collapsed"> + <a href="project-reports.html">Project Reports</a> + </li> + </ul> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img> + </a> + + + + + + + + + </div> + </div> + <div id="bodyColumn"> + <div id="contentBox"> + <div class="section"><h2><a name="torque:datasql"></a>torque:datasql</h2> +<p><strong>Full name</strong>:</p> +<p>org.apache.torque:torque-maven-plugin:3.3.1-SNAPSHOT:datasql</p> +<p><strong>Description</strong>:</p> +<div>Generates SQL for populating the database from data.xml files.</div><p><strong>Attributes</strong>:</p> +<ul><li>Requires a Maven 2.0 project to be executed.</li> +<li>Binds by default to the lifecycle phase: <code>generate-sources</code>.</li> +</ul> +<div class="section"><h3><a name="Required_Parameters"></a>Required Parameters</h3> +<table class="bodyTable"><tr class="a"><th>Name</th> +<th>Type</th> +<th>Since</th> +<th>Description</th> +</tr> +<tr class="b"><td><strong><a href="#dataDtd">dataDtd</a></strong></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The data dtd file for the data xml file to process.<br /> +</td> +</tr> +<tr class="a"><td><strong><a href="#dataXmlFile">dataXmlFile</a></strong></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The data Xml file to process.<br /> +</td> +</tr> +<tr class="b"><td><strong><a href="#schemaDir">schemaDir</a></strong></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The path to the directory where the schema files are located in.<br /> +</td> +</tr> +<tr class="a"><td><strong><a href="#schemaIncludes">schemaIncludes</a></strong></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The schema files which should be included in generation (in +ant-style notation).<br /> +</td> +</tr> +<tr class="b"><td><strong><a href="#targetDatabase">targetDatabase</a></strong></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The database type (e.g. mysql, oracle, ...) for the generated +persistence classes,<br /> +</td> +</tr> +</table> +</div> +<div class="section"><h3><a name="Optional_Parameters"></a>Optional Parameters</h3> +<table class="bodyTable"><tr class="a"><th>Name</th> +<th>Type</th> +<th>Since</th> +<th>Description</th> +</tr> +<tr class="b"><td><strong><a href="#outputDir">outputDir</a></strong></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The directory in which the sql will be generated.<br /> +</td> +</tr> +<tr class="a"><td><strong><a href="#reportFile">reportFile</a></strong></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The location where the sql file will be generated.<br /> +</td> +</tr> +<tr class="b"><td><strong><a href="#contextPropertiesPath">contextPropertiesPath</a></strong></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The location where the context property file for velocity will be +generated.<br /> +</td> +</tr> +<tr class="a"><td><strong><a href="#schemaExcludes">schemaExcludes</a></strong></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The schema files which should be excluded in generation (in +ant-style notation).<br /> +</td> +</tr> +<tr class="b"><td><strong><a href="#runOnlyOnSchemaChange">runOnlyOnSchemaChange</a></strong></td> +<td><code>boolean</code></td> +<td><code>-</code></td> +<td>Determines if this task should run only if the schema has changed.<br /> +</td> +</tr> +<tr class="a"><td><strong><a href="#sqlDbMap">sqlDbMap</a></strong></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The path to the properties file containing the mapping sql file +-> target database.<br /> +</td> +</tr> +<tr class="b"><td><strong><a href="#targetPackage">targetPackage</a></strong></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The target package for the generated classes.<br /> +</td> +</tr> +<tr class="a"><td><strong><a href="#templatePath">templatePath</a></strong></td> +<td><code>String</code></td> +<td><code>-</code></td> +<td>The base path where the templates are read from, if they are not +read from the classpath.<br /> +</td> +</tr> +<tr class="b"><td><strong><a href="#useClasspath">useClasspath</a></strong></td> +<td><code>boolean</code></td> +<td><code>-</code></td> +<td>Whether the templates should be loaded from the classpath.<br /> +</td> +</tr> +<tr class="a"><td><strong><a href="#userContextProperties">userContextProperties</a></strong></td> +<td><code>Map</code></td> +<td><code>-</code></td> +<td>A map where all user-defined context properties can be set. +Overrides all other mojo configuration settings which are mapped to +context properties.<br /> +</td> +</tr> +</table> +</div> +<div class="section"><h3><a name="Parameter_Details"></a>Parameter Details</h3> +<p><strong><a name="dataDtd">dataDtd</a>:</strong></p> +<div>The data dtd file for the data xml file to process.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>Yes</code></li> +</ul> +<hr /> +<p><strong><a name="dataXmlFile">dataXmlFile</a>:</strong></p> +<div>The data Xml file to process.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>Yes</code></li> +</ul> +<hr /> +<p><strong><a name="outputDir">outputDir</a>:</strong></p> +<div>The directory in which the sql will be generated.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Expression</strong>: <code>${project.build.directory}/generated-sql/torque</code></li> +</ul> +<hr /> +<p><strong><a name="reportFile">reportFile</a>:</strong></p> +<div>The location where the sql file will be generated.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Expression</strong>: <code>${project.artifact.artifactId}-data.sql</code></li> +</ul> +<hr /> +<p><strong><a name="contextPropertiesPath">contextPropertiesPath</a>:</strong></p> +<div>The location where the context property file for velocity will be +generated.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Expression</strong>: <code>${project.build.directory}/torque/context.datasql.properties</code></li> +</ul> +<hr /> +<p><strong><a name="schemaExcludes">schemaExcludes</a>:</strong></p> +<div>The schema files which should be excluded in generation (in +ant-style notation).</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Expression</strong>: <code>id-table-schema.xml</code></li> +</ul> +<hr /> +<p><strong><a name="runOnlyOnSchemaChange">runOnlyOnSchemaChange</a>:</strong></p> +<div>Determines if this task should run only if the schema has changed.</div><ul><li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Expression</strong>: <code>true</code></li> +</ul> +<hr /> +<p><strong><a name="schemaDir">schemaDir</a>:</strong></p> +<div>The path to the directory where the schema files are located in.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>Yes</code></li> +<li><strong>Expression</strong>: <code>${basedir}/src/main/torque/schema</code></li> +</ul> +<hr /> +<p><strong><a name="schemaIncludes">schemaIncludes</a>:</strong></p> +<div>The schema files which should be included in generation (in +ant-style notation).</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>Yes</code></li> +<li><strong>Expression</strong>: <code>*schema.xml</code></li> +</ul> +<hr /> +<p><strong><a name="sqlDbMap">sqlDbMap</a>:</strong></p> +<div>The path to the properties file containing the mapping sql file +-> target database.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Expression</strong>: <code>${project.build.directory}/torque/sqldbmap.properties</code></li> +</ul> +<hr /> +<p><strong><a name="targetDatabase">targetDatabase</a>:</strong></p> +<div>The database type (e.g. mysql, oracle, ...) for the generated +persistence classes,</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>Yes</code></li> +</ul> +<hr /> +<p><strong><a name="targetPackage">targetPackage</a>:</strong></p> +<div>The target package for the generated classes.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Expression</strong>: <code>torque.generated</code></li> +</ul> +<hr /> +<p><strong><a name="templatePath">templatePath</a>:</strong></p> +<div>The base path where the templates are read from, if they are not +read from the classpath.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Expression</strong>: <code>${basedir}/src/main/torque/templates</code></li> +</ul> +<hr /> +<p><strong><a name="useClasspath">useClasspath</a>:</strong></p> +<div>Whether the templates should be loaded from the classpath.</div><ul><li><strong>Type</strong>: <code>boolean</code></li> +<li><strong>Required</strong>: <code>No</code></li> +<li><strong>Expression</strong>: <code>true</code></li> +</ul> +<hr /> +<p><strong><a name="userContextProperties">userContextProperties</a>:</strong></p> +<div>A map where all user-defined context properties can be set. +Overrides all other mojo configuration settings which are mapped to +context properties.</div><ul><li><strong>Type</strong>: <code>java.util.Map</code></li> +<li><strong>Required</strong>: <code>No</code></li> +</ul> +</div> +</div> + + </div> + </div> + <div class="clear"> + <hr/> + </div> + <div id="footer"> + <div class="xright">© + 2000-2012 + + Apache Software Foundation + + + + + + + + + </div> + <div class="clear"> + <hr/> + </div> + </div> + </body> +</html>
--------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
