76af67326d455ec6fb8d0e6b9a43176f258c3e0b
[hibernate4-maven-plugin] / src / site / apt / index.apt
1   ---
2   A simple Plugin for generating a Database-Schema from Hibernate 4 Mapping-Annotations.
3   ---
4   Kai Moritz
5   ---
6
7   <<hibernate4-maven-plugin>> is a plugin for generating a database-schema
8   from your Hibernate-4-Mappings and create or update your database
9   accordingly.
10   Its main usage is to automatically create and populate a test-database
11   for unit-tests in cooperation with the
12   {{{http://mojo.codehaus.org/dbunit-maven-plugin/} dbunit-maven-plugin}}.
13
14   The plugin was designed with three main goals in mind:
15
16     * It should be easy to use.
17
18     * It should be maximal unlikely, to erase a producation-database by
19       accident.
20
21     * It should not slow down the development cycle.
22
23   To achieve the first goal, the convention-over-configuration paradigma
24   was applied and the plugin was stuffed with usefull logging-messages.
25   So, if in doubt, just turn on the {{{./debugging.html} debugging output}} with the <<<mvn -X ...>>>. 
26
27   To achieve the second goal, the precedence in which the configuration
28   locations are consulted was layouted in a way that makes it possible, to
29   prevent overwrites of the wrong database by accident.
30
31   Last but not least, in order to not slow down the development cycle, the
32   hibernate4-maven-plugin only executes the schema-export, if the mapping
33   or the dialect changes (or if you force it to do so).
34
35   For more information about the inspiration to write this tiny plugin,
36   {{{/hibernate4-maven-plugin-a-simple-plugin-for-generating-a-database-schema-from-hibernate-4-mapping-annotations/} read our blog-article about the hibernate4-maven-plugin}}.
37
38 Documentation
39
40  * See {{{./configuration.html} Configuration Examples}} for Usage-Explanations
41    and simple examples of how to use this plugin.
42
43  * See {{{./export-mojo.html}hibernate4:export}} and
44     {{{./plugin-info.html} Plugin Documentation}} for the full
45    autogenerated documentation. These are mostly configuration-options
46    of the Hibernate-Tools <<<SchemaExport>>> and <<<SchemaUpdate>>>, that do
47    the work in the background.
48
49 Releases
50
51  * {{{http://juplo.de/hibernate4-maven-plugin} current version}}
52
53  * ${project.version} (this version)
54
55  * {{{http://juplo.de/hibernate4-maven-plugin-1.0.2} 1.0.2}}
56
57  * {{{http://juplo.de/hibernate4-maven-plugin-1.0.1} 1.0.1}}
58
59  * {{{http://juplo.de/hibernate4-maven-plugin-1.0} 1.0}}