maven-plugins/hibernate/xdocs/properties.xml

180 lines
6.0 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>Hibernate Settings</title>
<author email="michal.maczka@dimatics.com">Michal Maczka</author>
</properties>
<body>
<section name="Hibernate Settings">
<table>
<tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
<tr>
<td>maven.hibernate.properties</td>
<td>No</td>
<td>
The location of Hibernate configuration file
(Java properties file). This file is also set in the
runtime by Hibernate for configuring Hibernate Session,
so it's better to keep it separately from the project's
configuration files like
<code>project.properties</code> etc.
<br/>
For description of the properties take a look
at <a href="http://www.hibernate.org/hib_docs/reference/en/html/session-configuration.html#configuration-hibernatejdbc">Hibernate User Guide</a>
</td>
</tr>
<tr>
<td>maven.hibernate.quiet</td>
<td>Yes</td>
<td>
Controls verbosity of the plugin.
Default is set to <code>yes</code>
</td>
</tr>
<tr>
<td>maven.hibernate.text</td>
<td>Yes</td>
<td>
It defaults to <code>no</code>. If set to true, then the
generated SQL will be output only to the filesystem, not
inserted into the database.
</td>
</tr>
<tr>
<td>maven.hibernate.drop</td>
<td>Yes</td>
<td>
Indicates whether to drop to generate just a drop table script.
<br/>
It defaults to <code>no</code>
</td>
</tr>
<tr>
<td>maven.hibernate.delimiter</td>
<td>Yes</td>
<td>String used to separate commands in SQL output.</td>
</tr>
<tr>
<td>maven.hibernate.output.dir</td>
<td>Yes</td>
<td>
The location of the directory where DDL SQL schema will
be generated by <code>schema-export</code> goal. It defaults to
<code>${maven.build.dir}/schema</code>
</td>
</tr>
<tr>
<td>maven.hibernate.output.file</td>
<td>Yes</td>
<td>
The name of the file which will be created by <code>schema-export</code>
goal. It defaults to
<code>${maven.hibernate.output.dir}/${maven.final.name}-schema.sql</code>.
</td>
</tr>
<tr>
<td>maven.hibernate.input.dir</td>
<td>Yes</td>
<td>
Comma-seperated list of base directories indicating where
mapping files are located. It defaults
to <code>${maven.build.dest}</code>.
</td>
</tr>
<tr>
<td>maven.hibernate.input.includes</td>
<td>Yes</td>
<td>
Comma-separated list of patterns of Hibernate mapping files,
which will be included during generation process.
<br/>
<b>Note</b>: Files are relative to
<code>${maven.hibernate.input.dir}</code>.
<br/>
By defaults all files are included:
<code>**/*.hbm.xml</code>.
</td>
</tr>
<tr>
<td>maven.hibernate.input.excludes</td>
<td>Yes</td>
<td>
Comma-separated list of patterns of Hibernate mapping files,
which will be excluded during generation process.
<br/>
<b>Note</b>: Files are relative to
<code>${maven.hibernate.input.dir}</code>.
<br/>
By default no files are excluded.
</td>
</tr>
<tr>
<td>maven.hibernate.aggregate.output.file</td>
<td>Yes</td>
<td>When <code>aggregate-mappings</code> is run, this file will contain the aggregated mappings</td>
</tr>
<tr>
<td>maven.hibernate.codeGeneration.input.dir</td>
<td>Yes</td>
<td>Comma-separated list of directories that contains Hibernate mapping files which will be used to generated Java classes when the goal <code>code-generation</code> is used.
It defaults to <code>${maven.src.dir}/hibernate</code>.
</td>
</tr>
<tr>
<td>maven.hibernate.codeGeneration.input.includes</td>
<td>Yes</td>
<td>
Comma-separated list of patterns of Hibernate mapping files,
which will be included during the code generation process (goal <code>code-generation</code>).
<br/>
<b>Note</b>: Files are relative to <code>${maven.hibernate.codeGeneration.input.dir}</code>.
<br/>
Default value is <code>${maven.hibernate.input.includes}</code>.
</td>
</tr>
<tr>
<td>maven.hibernate.codeGeneration.input.excludes</td>
<td>Yes</td>
<td>
Comma-separated list of patterns of Hibernate mapping files,
which will be excluded during the code generation process (goal <code>code-generation</code>).
<br/>
<b>Note</b>: Files are relative to
<code>${maven.hibernate.codeGeneration.input.dir}</code>.
<br/>
By default no files are excluded.
</td>
</tr>
<tr>
<td>maven.hibernate.codeGeneration.output.dir</td>
<td>Yes</td>
<td>When <code>code-generation</code> is run, the generated Java files will be placed in
this directory. It defaults to <code>${maven.src.dir}/hibernate</code>.</td>
</tr>
</table>
</section>
</body>
</document>