1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
\r
2 <!-- Generated by Apache Maven Doxia at Nov 29, 2012 -->
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
\r
6 <title>Hibernate 4 Maven Plugin -
7 hibernate4:export</title>
\r
8 <style type="text/css" media="all">
\r
9 @import url("./css/maven-base.css");
\r
10 @import url("./css/maven-theme.css");
\r
11 @import url("./css/site.css");
\r
13 <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
\r
14 <meta name="Date-Revision-yyyymmdd" content="20121129" />
\r
15 <meta http-equiv="Content-Language" content="en" />
\r
18 <body class="composite">
\r
20 <div id="bannerLeft">
\r
21 Hibernate 4 Maven Plugin
\r
27 <div id="breadcrumbs">
\r
31 <span id="publishDate">Last Published: 2012-11-29</span>
\r
32 | <span id="projectVersion">Version: 1.0</span>
\r
34 <div class="xright">
\r
41 <div id="leftColumn">
\r
42 <div id="navcolumn">
\r
48 <a href="index.html" title="Introduction">Introduction</a>
\r
51 <a href="examples.html" title="Examples">Examples</a>
\r
54 <a href="plugin-info.html" title="Documentation">Documentation</a>
\r
57 <h5>Project Documentation</h5>
\r
59 <li class="collapsed">
\r
60 <a href="project-info.html" title="Project Information">Project Information</a>
\r
62 <li class="collapsed">
\r
63 <a href="project-reports.html" title="Project Reports">Project Reports</a>
\r
66 <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
\r
67 <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
\r
73 <div id="bodyColumn">
\r
74 <div id="contentBox">
\r
77 <div class="section"><h2>hibernate4:export<a name="hibernate4:export"></a></h2>
78 <p><b>Full name</b>:</p>
79 <p>de.juplo:hibernate4-maven-plugin:1.0:export</p>
80 <p><b>Description</b>:</p>
81 <div>Goal which extracts the hibernate-mapping-configuration and exports
82 an according SQL-database-schema.</div>
83 <p><b>Attributes</b>:</p>
85 <li>Requires a Maven project to be executed.</li>
86 <li>Requires dependency resolution of artifacts in scope: <tt>runtime</tt>.</li>
87 <li>The goal is thread-safe and supports parallel builds.</li>
88 <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>
90 <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
91 <table align="center" class="bodyTable" border="0">
93 <th align="left">Name</th>
94 <th align="left">Type</th>
95 <th align="left">Since</th>
96 <th align="left">Description</th>
99 <td align="left"><b><a href="#delimiter">delimiter</a></b></td>
100 <td align="left"><tt>String</tt></td>
101 <td align="left"><tt>-</tt></td>
102 <td align="left">Delimiter in output-file.<br /><b>Default value is</b>: <tt>;</tt>.<br /></td>
105 <td align="left"><b><a href="#driverClassName">driverClassName</a></b></td>
106 <td align="left"><tt>String</tt></td>
107 <td align="left"><tt>-</tt></td>
108 <td align="left">SQL-Driver name.<br /><b>User property is</b>: <tt>hibernate.connection.driver_class</tt>.</td>
111 <td align="left"><b><a href="#format">format</a></b></td>
112 <td align="left"><tt>boolean</tt></td>
113 <td align="left"><tt>-</tt></td>
114 <td align="left">Format output-file.<br /><b>Default value is</b>: <tt>true</tt>.<br /></td>
117 <td align="left"><b><a href="#hibernateDialect">hibernateDialect</a></b></td>
118 <td align="left"><tt>String</tt></td>
119 <td align="left"><tt>-</tt></td>
120 <td align="left">Hibernate dialect.<br /><b>User property is</b>: <tt>hibernate.dialect</tt>.</td>
123 <td align="left"><b><a href="#hibernateProperties">hibernateProperties</a></b></td>
124 <td align="left"><tt>String</tt></td>
125 <td align="left"><tt>-</tt></td>
126 <td align="left">Hibernate configuration file.<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}/hibernate.properties</tt>.<br /></td>
129 <td align="left"><b><a href="#outputDirectory">outputDirectory</a></b></td>
130 <td align="left"><tt>String</tt></td>
131 <td align="left"><tt>-</tt></td>
132 <td align="left">Directories to scan.<br /><b>User property is</b>: <tt>project.build.outputDirectory</tt>.</td>
135 <td align="left"><b><a href="#outputFile">outputFile</a></b></td>
136 <td align="left"><tt>String</tt></td>
137 <td align="left"><tt>-</tt></td>
138 <td align="left">Output file.<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}/schema.sql</tt>.<br /></td>
141 <td align="left"><b><a href="#password">password</a></b></td>
142 <td align="left"><tt>String</tt></td>
143 <td align="left"><tt>-</tt></td>
144 <td align="left">Database password<br /><b>User property is</b>: <tt>hibernate.connection.password</tt>.</td>
147 <td align="left"><b><a href="#skip">skip</a></b></td>
148 <td align="left"><tt>boolean</tt></td>
149 <td align="left"><tt>-</tt></td>
150 <td align="left">Skip execution<br /><b>User property is</b>: <tt>maven.test.skip</tt>.</td>
153 <td align="left"><b><a href="#target">target</a></b></td>
154 <td align="left"><tt>String</tt></td>
155 <td align="left"><tt>-</tt></td>
156 <td align="left">Target of execution:
158 <li><b>NONE</b> do nothing - just validate the
160 <li><b>EXPORT</b> create database
161 <b>(DEFAULT!)</b></li>
162 <li><b>SCRIPT</b> export schema to SQL-script</li>
164 </ul><br /><b>Default value is</b>: <tt>EXPORT</tt>.<br /></td>
167 <td align="left"><b><a href="#type">type</a></b></td>
168 <td align="left"><tt>String</tt></td>
169 <td align="left"><tt>-</tt></td>
170 <td align="left">Type of export.
172 <li><b>NONE</b> do nothing - just validate the
174 <li><b>CREATE</b> create database-schema</li>
175 <li><b>DROP</b> drop database-schema</li>
176 <li><b>BOTH</b> <b>(DEFAULT!)</b></li>
177 </ul><br /><b>Default value is</b>: <tt>BOTH</tt>.<br /></td>
180 <td align="left"><b><a href="#url">url</a></b></td>
181 <td align="left"><tt>String</tt></td>
182 <td align="left"><tt>-</tt></td>
183 <td align="left">Database URL.<br /><b>User property is</b>: <tt>hibernate.connection.url</tt>.</td>
186 <td align="left"><b><a href="#username">username</a></b></td>
187 <td align="left"><tt>String</tt></td>
188 <td align="left"><tt>-</tt></td>
189 <td align="left">Database username<br /><b>User property is</b>: <tt>hibernate.connection.username</tt>.</td>
193 <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3>
194 <p><b><a name="delimiter">delimiter</a>:</b></p>
195 <div>Delimiter in output-file.</div>
197 <li><b>Type</b>: <tt>java.lang.String</tt></li>
198 <li><b>Required</b>: <tt>No</tt></li>
199 <li><b>Default</b>: <tt>;</tt></li>
200 </ul><hr /><p><b><a name="driverClassName">driverClassName</a>:</b></p>
201 <div>SQL-Driver name.</div>
203 <li><b>Type</b>: <tt>java.lang.String</tt></li>
204 <li><b>Required</b>: <tt>No</tt></li>
205 <li><b>User Property</b>: <tt>hibernate.connection.driver_class</tt></li>
206 </ul><hr /><p><b><a name="format">format</a>:</b></p>
207 <div>Format output-file.</div>
209 <li><b>Type</b>: <tt>boolean</tt></li>
210 <li><b>Required</b>: <tt>No</tt></li>
211 <li><b>Default</b>: <tt>true</tt></li>
212 </ul><hr /><p><b><a name="hibernateDialect">hibernateDialect</a>:</b></p>
213 <div>Hibernate dialect.</div>
215 <li><b>Type</b>: <tt>java.lang.String</tt></li>
216 <li><b>Required</b>: <tt>No</tt></li>
217 <li><b>User Property</b>: <tt>hibernate.dialect</tt></li>
218 </ul><hr /><p><b><a name="hibernateProperties">hibernateProperties</a>:</b></p>
219 <div>Hibernate configuration file.</div>
221 <li><b>Type</b>: <tt>java.lang.String</tt></li>
222 <li><b>Required</b>: <tt>No</tt></li>
223 <li><b>Default</b>: <tt>${project.build.outputDirectory}/hibernate.properties</tt></li>
224 </ul><hr /><p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
225 <div>Directories to scan.</div>
227 <li><b>Type</b>: <tt>java.lang.String</tt></li>
228 <li><b>Required</b>: <tt>No</tt></li>
229 <li><b>User Property</b>: <tt>project.build.outputDirectory</tt></li>
230 </ul><hr /><p><b><a name="outputFile">outputFile</a>:</b></p>
231 <div>Output file.</div>
233 <li><b>Type</b>: <tt>java.lang.String</tt></li>
234 <li><b>Required</b>: <tt>No</tt></li>
235 <li><b>Default</b>: <tt>${project.build.outputDirectory}/schema.sql</tt></li>
236 </ul><hr /><p><b><a name="password">password</a>:</b></p>
237 <div>Database password</div>
239 <li><b>Type</b>: <tt>java.lang.String</tt></li>
240 <li><b>Required</b>: <tt>No</tt></li>
241 <li><b>User Property</b>: <tt>hibernate.connection.password</tt></li>
242 </ul><hr /><p><b><a name="skip">skip</a>:</b></p>
243 <div>Skip execution</div>
245 <li><b>Type</b>: <tt>boolean</tt></li>
246 <li><b>Required</b>: <tt>No</tt></li>
247 <li><b>User Property</b>: <tt>maven.test.skip</tt></li>
248 </ul><hr /><p><b><a name="target">target</a>:</b></p>
249 <div>Target of execution:
251 <li><b>NONE</b> do nothing - just validate the
253 <li><b>EXPORT</b> create database
254 <b>(DEFAULT!)</b></li>
255 <li><b>SCRIPT</b> export schema to SQL-script</li>
259 <li><b>Type</b>: <tt>java.lang.String</tt></li>
260 <li><b>Required</b>: <tt>No</tt></li>
261 <li><b>Default</b>: <tt>EXPORT</tt></li>
262 </ul><hr /><p><b><a name="type">type</a>:</b></p>
265 <li><b>NONE</b> do nothing - just validate the
267 <li><b>CREATE</b> create database-schema</li>
268 <li><b>DROP</b> drop database-schema</li>
269 <li><b>BOTH</b> <b>(DEFAULT!)</b></li>
272 <li><b>Type</b>: <tt>java.lang.String</tt></li>
273 <li><b>Required</b>: <tt>No</tt></li>
274 <li><b>Default</b>: <tt>BOTH</tt></li>
275 </ul><hr /><p><b><a name="url">url</a>:</b></p>
276 <div>Database URL.</div>
278 <li><b>Type</b>: <tt>java.lang.String</tt></li>
279 <li><b>Required</b>: <tt>No</tt></li>
280 <li><b>User Property</b>: <tt>hibernate.connection.url</tt></li>
281 </ul><hr /><p><b><a name="username">username</a>:</b></p>
282 <div>Database username</div>
284 <li><b>Type</b>: <tt>java.lang.String</tt></li>
285 <li><b>Required</b>: <tt>No</tt></li>
286 <li><b>User Property</b>: <tt>hibernate.connection.username</tt></li>
294 <div class="clear">
\r
298 <div class="xright">Copyright © 2012.
\r
299 All Rights Reserved.
\r
302 <div class="clear">
\r