--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">\r
+<!-- Generated by Apache Maven Doxia at Jan 15, 2013 -->\r
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
+ <head>\r
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
+ <title>Hibernate 4 Maven Plugin -
+ hibernate4:export</title>\r
+ <style type="text/css" media="all">\r
+ @import url("./css/maven-base.css");\r
+ @import url("./css/maven-theme.css");\r
+ @import url("./css/site.css");\r
+ </style>\r
+ <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />\r
+ <meta name="Date-Revision-yyyymmdd" content="20130115" />\r
+ <meta http-equiv="Content-Language" content="en" />\r
+
+<script type="text/javascript"><!--
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-571104-3']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ //--></script>\r
+ \r
+ </head>\r
+ <body class="composite">\r
+ <div id="banner">\r
+ <div id="bannerLeft">\r
+ Hibernate 4 Maven Plugin\r
+ </div>\r
+ <div class="clear">\r
+ <hr/>\r
+ </div>\r
+ </div>\r
+ <div id="breadcrumbs">\r
+ \r
+ \r
+ <div class="xleft">\r
+ <span id="publishDate">Last Published: 2013-01-15</span>\r
+ | <span id="projectVersion">Version: 1.0.1</span>\r
+ | <a href="http://juplo.de" class="externalLink" title="juplo">juplo</a>\r
+ </div>\r
+ <div class="xright"> \r
+ \r
+ </div>\r
+ <div class="clear">\r
+ <hr/>\r
+ </div>\r
+ </div>\r
+ <div id="leftColumn">\r
+ <div id="navcolumn">\r
+ \r
+ \r
+ <h5>Overview</h5>\r
+ <ul>\r
+ <li class="none">\r
+ <a href="index.html" title="Introduction">Introduction</a>\r
+ </li>\r
+ <li class="none">\r
+ <a href="configuration.html" title="Configuration Examples">Configuration Examples</a>\r
+ </li>\r
+ <li class="none">\r
+ <strong>Parameter Documentation</strong>\r
+ </li>\r
+ <li class="none">\r
+ <a href="debugging.html" title="Enable Debug-Output">Enable Debug-Output</a>\r
+ </li>\r
+ <li class="none">\r
+ <a href="force.html" title="Force Exceution">Force Exceution</a>\r
+ </li>\r
+ <li class="none">\r
+ <a href="pitfalls.html" title="Known Pitfalls">Known Pitfalls</a>\r
+ </li>\r
+ </ul>\r
+ <h5>Project Documentation</h5>\r
+ <ul>\r
+ <li class="collapsed">\r
+ <a href="project-info.html" title="Project Information">Project Information</a>\r
+ </li>\r
+ <li class="collapsed">\r
+ <a href="project-reports.html" title="Project Reports">Project Reports</a>\r
+ </li>\r
+ </ul>\r
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">\r
+ <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />\r
+ </a>\r
+ \r
+ \r
+ </div>\r
+ </div>\r
+ <div id="bodyColumn">\r
+ <div id="contentBox">\r
+
+
+ <div class="section"><h2>hibernate4:export<a name="hibernate4:export"></a></h2>
+ <p><b>Full name</b>:</p>
+ <p>de.juplo:hibernate4-maven-plugin:1.0.1:export</p>
+ <p><b>Description</b>:</p>
+ <div>Goal which extracts the hibernate-mapping-configuration and exports
+an according SQL-database-schema.</div>
+ <p><b>Attributes</b>:</p>
+ <ul>
+ <li>Requires a Maven project to be executed.</li>
+ <li>Requires dependency resolution of artifacts in scope: <tt>runtime</tt>.</li>
+ <li>The goal is thread-safe and supports parallel builds.</li>
+ <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>process-classes</tt>.</li>
+ </ul>
+ <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
+ <table align="center" class="bodyTable" border="0">
+ <tr class="a">
+ <th align="left">Name</th>
+ <th align="left">Type</th>
+ <th align="left">Since</th>
+ <th align="left">Description</th>
+ </tr>
+ <tr class="b">
+ <td align="left"><b><a href="#delimiter">delimiter</a></b></td>
+ <td align="left"><tt>String</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Delimiter in output-file.<br /><b>Default value is</b>: <tt>;</tt>.<br /><b>User property is</b>: <tt>hibernate.export.schema.delimiter</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><b><a href="#driverClassName">driverClassName</a></b></td>
+ <td align="left"><tt>String</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">SQL-Driver name.<br /><b>User property is</b>: <tt>hibernate.connection.driver_class</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><b><a href="#force">force</a></b></td>
+ <td align="left"><tt>boolean</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Force execution
+<p>Force execution, even if no modified or newly added annotated
+classes where found and the dialect was not changed.</p>
+<p><tt>skip</tt> takes precedence over <tt>force</tt>.</p><br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>hibernate.export.force</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><b><a href="#format">format</a></b></td>
+ <td align="left"><tt>boolean</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Format output-file.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>hibernate.export.schema.format</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><b><a href="#hibernateDialect">hibernateDialect</a></b></td>
+ <td align="left"><tt>String</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Hibernate dialect.<br /><b>User property is</b>: <tt>hibernate.dialect</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><b><a href="#hibernateProperties">hibernateProperties</a></b></td>
+ <td align="left"><tt>String</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Path to Hibernate configuration file.<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}/hibernate.properties</tt>.<br /></td>
+ </tr>
+ <tr class="b">
+ <td align="left"><b><a href="#outputDirectory">outputDirectory</a></b></td>
+ <td align="left"><tt>String</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Classes-Directory to scan.
+<p>This parameter defaults to the maven build-output-directory for
+classes. Additonally, all dependencies are scanned for annotated
+classes.</p><br /><b>User property is</b>: <tt>project.build.outputDirectory</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><b><a href="#outputFile">outputFile</a></b></td>
+ <td align="left"><tt>String</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Output file.<br /><b>Default value is</b>: <tt>${project.build.directory}/schema.sql</tt>.<br /><b>User property is</b>: <tt>hibernate.export.schema.filename</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><b><a href="#password">password</a></b></td>
+ <td align="left"><tt>String</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Database password<br /><b>User property is</b>: <tt>hibernate.connection.password</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><b><a href="#scanTestClasses">scanTestClasses</a></b></td>
+ <td align="left"><tt>boolean</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Wether to scan test-classes too, or not.
+<p>If this parameter is set to <tt>true</tt> the test-classes
+of the artifact will be scanned for hibernate-annotated classes
+additionally.</p><br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>hibernate.export.scann_testclasses</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><b><a href="#skip">skip</a></b></td>
+ <td align="left"><tt>boolean</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Skip execution
+<p>If set to <tt>true</tt>, the execution is skipped.</p>
+<p>A skipped excecution is signaled via the maven-property
+<tt>${hibernate.export.skipped}</tt>.</p>
+<p>The excecution is skipped automatically, if no modified or newly
+added annotated classes are found and the dialect was not
+changed.</p><br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>maven.test.skip</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><b><a href="#target">target</a></b></td>
+ <td align="left"><tt>String</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Target of execution:
+<ul>
+<li><b>NONE</b> do nothing - just validate the
+configuration (forces excecution, signals skip)</li>
+<li><b>EXPORT</b> create database
+(<b>DEFAULT!</b>. forces excecution, signals skip)</li>
+<li><b>SCRIPT</b> export schema to SQL-script</li>
+<li><b>BOTH</b></li>
+</ul><br /><b>Default value is</b>: <tt>EXPORT</tt>.<br /><b>User property is</b>: <tt>hibernate.export.target</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><b><a href="#testOutputDirectory">testOutputDirectory</a></b></td>
+ <td align="left"><tt>String</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Test-Classes-Directory to scan.
+<p>This parameter defaults to the maven build-output-directory for
+test-classes.</p>
+<p>This parameter is only used, when <tt>scanTestClasses</tt>
+is set to <tt>true</tt>!</p><br /><b>User property is</b>: <tt>project.build.testOutputDirectory</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><b><a href="#type">type</a></b></td>
+ <td align="left"><tt>String</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Type of execution.
+<ul>
+<li><b>NONE</b> do nothing - just validate the
+configuration</li>
+<li><b>CREATE</b> create database-schema</li>
+<li><b>DROP</b> drop database-schema</li>
+<li><b>BOTH</b> (<b>DEFAULT!</b>)</li>
+</ul><br /><b>Default value is</b>: <tt>BOTH</tt>.<br /><b>User property is</b>: <tt>hibernate.export.type</tt>.</td>
+ </tr>
+ <tr class="b">
+ <td align="left"><b><a href="#url">url</a></b></td>
+ <td align="left"><tt>String</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Database URL.<br /><b>User property is</b>: <tt>hibernate.connection.url</tt>.</td>
+ </tr>
+ <tr class="a">
+ <td align="left"><b><a href="#username">username</a></b></td>
+ <td align="left"><tt>String</tt></td>
+ <td align="left"><tt>-</tt></td>
+ <td align="left">Database username<br /><b>User property is</b>: <tt>hibernate.connection.username</tt>.</td>
+ </tr>
+ </table>
+ </div>
+ <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
+ <p><b><a name="delimiter">delimiter</a>:</b></p>
+ <div>Delimiter in output-file.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>hibernate.export.schema.delimiter</tt></li>
+ <li><b>Default</b>: <tt>;</tt></li>
+ </ul><hr /><p><b><a name="driverClassName">driverClassName</a>:</b></p>
+ <div>SQL-Driver name.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>hibernate.connection.driver_class</tt></li>
+ </ul><hr /><p><b><a name="force">force</a>:</b></p>
+ <div>Force execution
+<p>Force execution, even if no modified or newly added annotated
+classes where found and the dialect was not changed.</p>
+<p><tt>skip</tt> takes precedence over <tt>force</tt>.</p></div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>hibernate.export.force</tt></li>
+ <li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr /><p><b><a name="format">format</a>:</b></p>
+ <div>Format output-file.</div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>hibernate.export.schema.format</tt></li>
+ <li><b>Default</b>: <tt>true</tt></li>
+ </ul><hr /><p><b><a name="hibernateDialect">hibernateDialect</a>:</b></p>
+ <div>Hibernate dialect.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>hibernate.dialect</tt></li>
+ </ul><hr /><p><b><a name="hibernateProperties">hibernateProperties</a>:</b></p>
+ <div>Path to Hibernate configuration file.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>Default</b>: <tt>${project.build.outputDirectory}/hibernate.properties</tt></li>
+ </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
+ <div>Classes-Directory to scan.
+<p>This parameter defaults to the maven build-output-directory for
+classes. Additonally, all dependencies are scanned for annotated
+classes.</p></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>project.build.outputDirectory</tt></li>
+ </ul><hr /><p><b><a name="outputFile">outputFile</a>:</b></p>
+ <div>Output file.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>hibernate.export.schema.filename</tt></li>
+ <li><b>Default</b>: <tt>${project.build.directory}/schema.sql</tt></li>
+ </ul><hr /><p><b><a name="password">password</a>:</b></p>
+ <div>Database password</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>hibernate.connection.password</tt></li>
+ </ul><hr /><p><b><a name="scanTestClasses">scanTestClasses</a>:</b></p>
+ <div>Wether to scan test-classes too, or not.
+<p>If this parameter is set to <tt>true</tt> the test-classes
+of the artifact will be scanned for hibernate-annotated classes
+additionally.</p></div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>hibernate.export.scann_testclasses</tt></li>
+ <li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr /><p><b><a name="skip">skip</a>:</b></p>
+ <div>Skip execution
+<p>If set to <tt>true</tt>, the execution is skipped.</p>
+<p>A skipped excecution is signaled via the maven-property
+<tt>${hibernate.export.skipped}</tt>.</p>
+<p>The excecution is skipped automatically, if no modified or newly
+added annotated classes are found and the dialect was not
+changed.</p></div>
+ <ul>
+ <li><b>Type</b>: <tt>boolean</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>maven.test.skip</tt></li>
+ <li><b>Default</b>: <tt>false</tt></li>
+ </ul><hr /><p><b><a name="target">target</a>:</b></p>
+ <div>Target of execution:
+<ul>
+<li><b>NONE</b> do nothing - just validate the
+configuration (forces excecution, signals skip)</li>
+<li><b>EXPORT</b> create database
+(<b>DEFAULT!</b>. forces excecution, signals skip)</li>
+<li><b>SCRIPT</b> export schema to SQL-script</li>
+<li><b>BOTH</b></li>
+</ul></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>hibernate.export.target</tt></li>
+ <li><b>Default</b>: <tt>EXPORT</tt></li>
+ </ul><hr /><p><b><a name="testOutputDirectory">testOutputDirectory</a>:</b></p>
+ <div>Test-Classes-Directory to scan.
+<p>This parameter defaults to the maven build-output-directory for
+test-classes.</p>
+<p>This parameter is only used, when <tt>scanTestClasses</tt>
+is set to <tt>true</tt>!</p></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>project.build.testOutputDirectory</tt></li>
+ </ul><hr /><p><b><a name="type">type</a>:</b></p>
+ <div>Type of execution.
+<ul>
+<li><b>NONE</b> do nothing - just validate the
+configuration</li>
+<li><b>CREATE</b> create database-schema</li>
+<li><b>DROP</b> drop database-schema</li>
+<li><b>BOTH</b> (<b>DEFAULT!</b>)</li>
+</ul></div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>hibernate.export.type</tt></li>
+ <li><b>Default</b>: <tt>BOTH</tt></li>
+ </ul><hr /><p><b><a name="url">url</a>:</b></p>
+ <div>Database URL.</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>hibernate.connection.url</tt></li>
+ </ul><hr /><p><b><a name="username">username</a>:</b></p>
+ <div>Database username</div>
+ <ul>
+ <li><b>Type</b>: <tt>java.lang.String</tt></li>
+ <li><b>Required</b>: <tt>No</tt></li>
+ <li><b>User Property</b>: <tt>hibernate.connection.username</tt></li>
+ </ul>
+ </div>
+ </div>
+
+\r
+ </div>\r
+ </div>\r
+ <div class="clear">\r
+ <hr/>\r
+ </div>\r
+ <div id="footer">\r
+ <div class="xright">Copyright © 2013.\r
+ All Rights Reserved. \r
+ \r
+ </div>\r
+ <div class="clear">\r
+ <hr/>\r
+ </div>\r
+ </div>\r
+ </body>\r
+</html>\r
projects / website / blobdiff