+++ /dev/null
-<!DOCTYPE html>
-<!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2014-04-29 -->
- <!-- Current: export-mojo.html -->
-<!-- Active: index.html -->
-<!-- Path: [index.html, export-mojo.html] -->
-<!-- Skiplist: [index.html, configuration.html, export-mojo.html, debugging.html, force.html, pitfalls.html] -->
-<html>
- <head>
- <title>juplo - Hibernate 4 Maven Plugin - Parameter Documentation</title>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
- <link rel="canonical" href="http://juplo.de/hibernate4-maven-plugin/export-mojo.html"/>
- <meta name="viewport" content="width=device-width, initial-scale=1" />
- <link rel="stylesheet" type="text/css" href="/css/base.css" />
- <style type="text/css">
- @import '/css/screen.css' screen;
- @import '/css/print.css' print;
- </style>
- <script src="/js/base.js"></script>
- <!--[if IE 8]>
- <link rel="stylesheet" type="text/css" href="/css/ie8.css" />
- <script src="/js/ie8.js"></script>
- <![endif]-->
- <!--[if IE 7]>
- <script src="/js/ie7.js"></script>
- <![endif]-->
- <!--[if lt IE 7]>
- <script src="/js/ie6.js"></script>
- <![endif]-->
- <meta name="Date-Revision-yyyymmdd" content="20140429" />
- <meta http-equiv="Content-Language" content="en" />
-
- </head>
- <body id="top" class="menu" onload="prettyPrint()">
- <div id="page" class="cf">
- <header id="header">
- <h1 id="logo"><a href="/" title="Home" class="l">juplo</a></h1>
- <span id="slogan"><strong>Java</strong> bits from nerds for nerds</span>
- <hr class="h" />
- </header>
- <div id="breadcrumb">
- <strong class="b title">You are here:</strong>
- <ol class="b">
- <li class="b"><a class="b" href="/">Home</a></li>
- <li class="b"><a class="b" href="/projects.html">Projects</a></li>
- <li class="b"><a class="b" href="./index.html">Hibernate 4 Maven Plugin</a </li>
- <li class="b"><strong class="b">Parameter Documentation</strong></li>
- </ol>
- <a class="hide" href="#nav" title="Show navigation menu">Jump to navigation</a>
- <hr class="b" />
- </div>
- <main class="content cf">
- <section id="content" class="main">
- <h1>Hibernate 4 Maven Plugin - Parameter Documentation</h1>
-
-
- <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.2: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 class="bodyTable" border="0">
-
-<tr class="a">
-
-<th>Name</th>
-
-<th>Type</th>
-
-<th>Since</th>
-
-<th>Description</th>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#delimiter">delimiter</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>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><b><a href="#driverClassName">driverClassName</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>SQL-Driver name.<br /><b>User property is</b>: <tt>hibernate.connection.driver_class</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#force">force</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>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><b><a href="#format">format</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>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><b><a href="#hibernateDialect">hibernateDialect</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>Hibernate dialect.<br /><b>User property is</b>: <tt>hibernate.dialect</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#hibernateMapping">hibernateMapping</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>List of Hibernate-Mapping-Files (XML). Multiple files can be
-separated with white-spaces and/or commas.<br /><b>User property is</b>: <tt>hibernate.mapping</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#hibernateNamingStrategy">hibernateNamingStrategy</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>Hibernate Naming Strategy<br /><b>User property is</b>: <tt>hibernate.ejb.naming_strategy</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#hibernateProperties">hibernateProperties</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>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><b><a href="#outputDirectory">outputDirectory</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>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><b><a href="#outputFile">outputFile</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>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><b><a href="#password">password</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>Database password<br /><b>User property is</b>: <tt>hibernate.connection.password</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#scanTestClasses">scanTestClasses</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>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.scan_testclasses</tt>.</td>
- </tr>
-
-<tr class="b">
-
-<td><b><a href="#skip">skip</a></b></td>
-
-<td><tt>boolean</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>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><b><a href="#target">target</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>Target of execution:
-
-<ul>
-
-<li><b>NONE</b> only export schema to SQL-script (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 and print
-it to STDOUT</li>
-
-<li><b>BOTH</b></li>
-</ul>
-A databaseconnection is only needed for EXPORT and BOTH, but a
-Hibernate-Dialect must always be choosen.<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><b><a href="#testOutputDirectory">testOutputDirectory</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>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><b><a href="#type">type</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>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>
-If NONE is choosen, no databaseconnection is needed.<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><b><a href="#url">url</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>Database URL.<br /><b>User property is</b>: <tt>hibernate.connection.url</tt>.</td>
- </tr>
-
-<tr class="a">
-
-<td><b><a href="#username">username</a></b></td>
-
-<td><tt>String</tt></td>
-
-<td><tt>-</tt></td>
-
-<td>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="hibernateMapping">hibernateMapping</a>:</b></p>
-
-<div>List of Hibernate-Mapping-Files (XML). Multiple files can be
-separated with white-spaces and/or commas.</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.mapping</tt></li>
- </ul><hr />
-<p><b><a name="hibernateNamingStrategy">hibernateNamingStrategy</a>:</b></p>
-
-<div>Hibernate Naming Strategy</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.ejb.naming_strategy</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.scan_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> only export schema to SQL-script (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 and print
-it to STDOUT</li>
-
-<li><b>BOTH</b></li>
-</ul>
-A databaseconnection is only needed for EXPORT and BOTH, but a
-Hibernate-Dialect must always be choosen.</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>
-If NONE is choosen, no databaseconnection is needed.</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>
-
-
- </section>
- <div class="marginal">
- <nav id="nav">
- <hr class="n" />
- <a class="hide" href="#top" title="Show Content">Jump back to the top of the page</a>
- <h2 class="nav menu">Section-Menu</h2>
- <ul id="menu">
- <li class="m blog"><a href="/blog/" class="m">Blog</a></li>
- <li class="m projects"><a href="/projects.html" class="m selected">Projects</a></li>
- </ul>
- <h2 class="nav submenu">
- <span class="s">Submenu for section</span>
- <a class="s selected" href="/projects.html">Projects</a>
- </h2>
- <ul id="submenu" class="s">
- <li class="s sub">
- <a class="s selected" href="./index.html">Hibernate 4 Maven Plugin</a>
- <ul class="s active">
- <li class="s">
- <a href="configuration.html" class="s" title="Configuration Examples">Configuration Examples</a>
- </li>
- <li class="s">
- <strong class="s">Parameter Documentation</strong>
- </li>
- <li class="s">
- <a href="debugging.html" class="s" title="Enable Debug-Output">Enable Debug-Output</a>
- </li>
- <li class="s">
- <a href="force.html" class="s" title="Force Exceution">Force Exceution</a>
- </li>
- <li class="s">
- <a href="pitfalls.html" class="s" title="Known Pitfalls (FAQ)">Known Pitfalls (FAQ)</a>
- </li>
- <li class="s sub">
- <a href="project-info.html" class="s" title="Project Information">Project Information</a>
- </li>
- <li class="s sub">
- <a href="project-reports.html" class="s" title="Project Reports">Project Reports</a>
- </li>
- </ul>
- </li>
- </ul>
- <hr class="n" />
- </nav>
- <p>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
- </a>
- </p>
- </div>
- </main>
- <footer id="footer">
- <hr class="f" />
- <ul id="footerlinks">
- <li class="f" id="copyright">© <strong>mo</strong> 2013</li>
- <li class="f"><a class="f" href="/impressum.html">Impressum</a></li>
- <li class="f about"><a class="f" href="/about.html">About</a></li>
- </ul>
- </footer>
- </div>
- <script type="text/javascript"><!--//--><![CDATA[//><!--
- 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);
- })();
- //--><!]]>
- </body>
-</html>