Updated documentation
[hibernate4-maven-plugin] / src / site / xhtml / index.xhtml
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3  <head>
4  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5  </head>
6  <body>
7   <h1>Hibernate Maven Plugin</h1>
8   <h2>A simple Plugin for generating a Database-Schema from Hibernate Mapping-Annotations</h2>
9   <p>
10   The <strong>hibernate-maven-plugin</strong> is a plugin for generating a database-schema
11   from your Hibernate-Mappings and create or update your database
12   accordingly.
13   Its main usage is to automatically create and populate a test-database
14   for unit-tests in cooperation with the
15   <a href="http://mojo.codehaus.org/dbunit-maven-plugin">dbunit-maven-plugin</a>.
16   </p>
17   <p>
18   The plugin was designed with three main goals in mind:
19   </p>
20   <ul>
21     <li>It should be easy to use.</li>
22     <li>It should be maximal unlikely, to erase a producation-database by accident.</li>
23     <li>It should not slow down the development cycle.</li>
24   </ul>
25   <p>
26   To achieve the first goal, the convention-over-configuration paradigma
27   was applied and the plugin was stuffed with usefull logging-messages.
28   So, if in doubt, just turn on the <a href="./debugging.html">debugging output</a> with the <code>mvn -X ...</code>. 
29   </p>
30   <p>
31   To achieve the second goal, the precedence in which the configuration
32   locations are consulted was layouted in a way that makes it possible, to
33   prevent overwrites of the wrong database by accident.
34   </p>
35   <p>
36   Last but not least, in order to not slow down the development cycle, the
37   hibernate-maven-plugin only executes the schema-export, if the mapping
38   or the dialect changes (or if you force it to do so).
39   </p>
40   <p>
41   For more information about the inspiration to write this tiny plugin,
42   <a href="/hibernate-maven-plugin-a-simple-plugin-for-generating-a-database-schema-from-hibernate-4-mapping-annotations/">read our blog-article about the hibernate-maven-plugin</a>.
43   </p>
44   <h2>Documentation</h2>
45   <ul>
46    <li>
47    See <a href="./configuration.html">Configuration Examples</a> for Usage-Explanations
48    and simple examples of how to use this plugin.
49    </li>
50    <li>
51    See <a href="./create-mojo.html">hibernate:create</a>,
52    See <a href="./drop-mojo.html">hibernate:drop</a> and
53    <a href="./plugin-info.html">Plugin Documentation</a> for the full
54    autogenerated documentation. These are mostly configuration-options
55    of the Hibernate-Tools <code>SchemaExport</code> and <code>SchemaUpdate</code>, that do
56    the work in the background.
57    </li>
58   </ul>
59   <h2>Releases</h2>
60   <ul>
61     <li><a href="http://juplo.de/hibernate-maven-plugin">current version</a></li>
62     <li>${project.version} (this version)</li>
63     <li><a href="http://juplo.de/hibernate4-maven-plugin-1.0.5">1.0.5</a></li>
64     <li><a href="http://juplo.de/hibernate4-maven-plugin-1.0.4">1.0.4</a></li>
65     <li><a href="http://juplo.de/hibernate4-maven-plugin-1.0.3">1.0.3</a></li>
66     <li><a href="http://juplo.de/hibernate4-maven-plugin-1.0.2">1.0.2</a></li>
67     <li><a href="http://juplo.de/hibernate4-maven-plugin-1.0.1">1.0.1</a></li>
68     <li><a href="http://juplo.de/hibernate4-maven-plugin-1.0">1.0</a></li>
69   </ul>
70  </body>
71 </html>