X-Git-Url: https://juplo.de/gitweb/?p=hibernate4-maven-plugin;a=blobdiff_plain;f=src%2Fsite%2Fapt%2Findex.apt;h=6311684674947def7843c12ceeb9b6671eb413ea;hp=3698529bac02dd8d963047052caacd81655a677c;hb=d38b2386641c7ca00f54d69cb3f576c20b0cdccc;hpb=17b00da14edf0d80c738b82dae9a4b3a1ba21ac7 diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt index 3698529b..63116846 100644 --- a/src/site/apt/index.apt +++ b/src/site/apt/index.apt @@ -3,19 +3,53 @@ A simple Plugin for generating a Database-Schema from Hibernate 4 Mapping-Annota <> is a plugin for generating a database-schema from your Hibernate-4-Mappings and create or update your database accordingly. + Its main usage is to automatically create and populate a test-database + for unit-tests in cooperation with the + {{{http://mojo.codehaus.org/dbunit-maven-plugin/} dbunit-maven-plugin}}. - The plugin was designed to be easy and safe to use, because it must not - never, never happen, that you blow away your production database when - firering a maven-build of your webapp on your production-machine! - For more information about the insiration to write this tiny plugin, + The plugin was designed with three main goals in mind: + + * It should be easy to use. + + * It should be maximal unlikely, to erase a producation-database by + accident. + + * It should not slow down the development cycle. + + To achieve the first goal, the convention-over-configuration paradigma + was applied and the plugin was stuffed with usefull logging-messages. + So, if in doubt, just turn on the {{{./debugging.html} debugging output}} with the <<>>. + + To achieve the second goal, the precedence in which the configuration + locations are consulted was layouted in a way that makes it possible, to + prevent overwrites of the wrong database by accident. + + Last but not least, in order to not slow down the development cycle, the + hibernate4-maven-plugin only executes the schema-export, if the mapping + or the dialect changes (or if you force it to do so). + + For more information about the inspiration to write this tiny plugin, {{{/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}}. -Documentation and Examples +* Documentation - * See {{{./examples.html} Examples}} for Usage-Eplanations and simple - examples of how to use this plugin. + * See {{{./configuration.html} Configuration Examples}} for Usage-Explanations + and simple examples of how to use this plugin. - * See {{{./plugin-info.html} Plugin Documentation}} for the full + * See {{{./export-mojo.html}hibernate4:export}} and + {{{./plugin-info.html} Plugin Documentation}} for the full autogenerated documentation. These are mostly configuration-options of the Hibernate-Tools <<>> and <<>>, that do the work in the background. + +* Releases + + * {{{http://juplo.de/hibernate4-maven-plugin} current version}} + + * ${project.version} (this version) + + * {{{http://juplo.de/hibernate4-maven-plugin-1.0.2} 1.0.2}} + + * {{{http://juplo.de/hibernate4-maven-plugin-1.0.1} 1.0.1}} + + * {{{http://juplo.de/hibernate4-maven-plugin-1.0} 1.0}}