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