juplo.de Git - website/blob - dist/hibernate4-maven-plugin-1.0.5/export-mojo.html

   1 <!DOCTYPE html>
   2 <!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2014-11-11 -->
   3                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               <!-- Current: export-mojo.html -->
   4 <!-- Active: index.html -->
   5 <!-- Path: [index.html, export-mojo.html] -->
   6 <!-- Skiplist: [index.html, configuration.html, export-mojo.html, debugging.html, skip.html, force.html, pitfalls.html] -->
   7 <html>
   8   <head>
   9     <title>juplo - Hibernate 4 Maven Plugin - Parameter Documentation</title>
  10     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  11     <link rel="canonical" href="http://juplo.de/hibernate4-maven-plugin/export-mojo.html"/>
  12     <meta name="viewport" content="width=device-width, initial-scale=1" />
  13     <link rel="stylesheet" type="text/css" href="/css/base.css" />
  14     <style type="text/css">
  15       @import '/css/screen.css' screen;
  16     </style>
  17     <script src="/js/base.js"></script>
  18     <!--[if IE 8]>
  19       <link rel="stylesheet" type="text/css" href="/css/ie8.css" />
  20       <script src="/js/ie8.js"></script>
  21     <![endif]-->
  22     <!--[if IE 7]>
  23       <script src="/js/ie7.js"></script>
  24     <![endif]-->
  25     <!--[if lt IE 7]>
  26       <script src="/js/ie6.js"></script>
  27     <![endif]-->
  28
  29   </head>
  30   <body class="menu" onload="prettyPrint()">
  31     <div id="page" class="cf">
  32       <header id="header">
  33         <h1 id="logo"><a href="/" title="Home" class="l">juplo</a></h1>
  34         <span id="slogan"><strong>Java</strong> bits from nerds for nerds</span>
  35         <hr class="h" />
  36       </header>
  37       <div id="breadcrumb">
  38         <strong class="b title">You are here:</strong>
  39         <ol class="b">
  40           <li class="b"><a class="b" href="/">Home</a></li>
  41           <li class="b"><a class="b" href="/projects.html">Projects</a></li>
  42                       <li class="b"><a class="b" href="./index.html">Hibernate 4 Maven Plugin</a></li>
  43                         <li class="b"><strong class="b">Parameter Documentation</strong></li>
  44                   </ol>
  45         <a class="hide" href="#navigation">Jump to navigation</a>
  46         <hr class="b" />
  47       </div>
  48       <main class="content cf">
  49         <article id="content" class="main">
  50           <header><h1>Parameter Documentation</h1></header>
  51
  52
  53     <div class="section">
  54 <h2>hibernate4:export<a name="hibernate4:export"></a></h2>
  55
  56 <p><b>Full name</b>:</p>
  57
  58 <p>de.juplo:hibernate4-maven-plugin:1.0.5:export</p>
  59
  60 <p><b>Description</b>:</p>
  61
  62 <div>Goal which extracts the hibernate-mapping-configuration and exports
  63 an according SQL-database-schema.</div>
  64
  65 <p><b>Attributes</b>:</p>
  66
  67 <ul>
  68
  69 <li>Requires a Maven project to be executed.</li>
  70
  71 <li>Requires dependency resolution of artifacts in scope: <tt>runtime</tt>.</li>
  72
  73 <li>The goal is thread-safe and supports parallel builds.</li>
  74
  75 <li>Binds by default to the <a class="externalLink" href="http://maven.apache.org/ref/current/maven-core/lifecycles.html">lifecycle phase</a>: <tt>process-classes</tt>.</li>
  76       </ul>
  77
  78 <div class="section">
  79 <h3>Optional Parameters<a name="Optional_Parameters"></a></h3>
  80
  81 <table class="bodyTable" border="0">
  82
  83 <tr class="a">
  84
  85 <th>Name</th>
  86
  87 <th>Type</th>
  88
  89 <th>Since</th>
  90
  91 <th>Description</th>
  92           </tr>
  93
  94 <tr class="b">
  95
  96 <td><b><a href="#delimiter">delimiter</a></b></td>
  97
  98 <td><tt>String</tt></td>
  99
 100 <td><tt>1.0</tt></td>
 101
 102 <td>Delimiter in output-file.<br /><b>Default value is</b>: <tt>;</tt>.<br /><b>User property is</b>: <tt>hibernate.export.schema.delimiter</tt>.</td>
 103           </tr>
 104
 105 <tr class="a">
 106
 107 <td><b><a href="#driverClassName">driverClassName</a></b></td>
 108
 109 <td><tt>String</tt></td>
 110
 111 <td><tt>1.0</tt></td>
 112
 113 <td>SQL-Driver name.<br /><b>User property is</b>: <tt>hibernate.connection.driver_class</tt>.</td>
 114           </tr>
 115
 116 <tr class="b">
 117
 118 <td><b><a href="#envers">envers</a></b></td>
 119
 120 <td><tt>boolean</tt></td>
 121
 122 <td><tt>1.0.3</tt></td>
 123
 124 <td>Generate envers schema for auditing tables.<br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>hibernate.export.envers</tt>.</td>
 125           </tr>
 126
 127 <tr class="a">
 128
 129 <td><b><a href="#force">force</a></b></td>
 130
 131 <td><tt>boolean</tt></td>
 132
 133 <td><tt>1.0</tt></td>
 134
 135 <td>Force execution
 136
 137 <p>Force execution, even if no modified or newly added annotated
 138 classes where found and the dialect was not changed.</p>
 139
 140 <p><tt>skip</tt> takes precedence over <tt>force</tt>.</p><br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>hibernate.export.force</tt>.</td>
 141           </tr>
 142
 143 <tr class="b">
 144
 145 <td><b><a href="#format">format</a></b></td>
 146
 147 <td><tt>boolean</tt></td>
 148
 149 <td><tt>1.0</tt></td>
 150
 151 <td>Format output-file.<br /><b>Default value is</b>: <tt>true</tt>.<br /><b>User property is</b>: <tt>hibernate.export.schema.format</tt>.</td>
 152           </tr>
 153
 154 <tr class="a">
 155
 156 <td><b><a href="#hibernateDialect">hibernateDialect</a></b></td>
 157
 158 <td><tt>String</tt></td>
 159
 160 <td><tt>1.0</tt></td>
 161
 162 <td>Hibernate dialect.<br /><b>User property is</b>: <tt>hibernate.dialect</tt>.</td>
 163           </tr>
 164
 165 <tr class="b">
 166
 167 <td><b><a href="#hibernateMapping">hibernateMapping</a></b></td>
 168
 169 <td><tt>String</tt></td>
 170
 171 <td><tt>1.0.2</tt></td>
 172
 173 <td>List of Hibernate-Mapping-Files (XML). Multiple files can be
 174 separated with white-spaces and/or commas.<br /><b>User property is</b>: <tt>hibernate.mapping</tt>.</td>
 175           </tr>
 176
 177 <tr class="a">
 178
 179 <td><b><a href="#hibernateNamingStrategy">hibernateNamingStrategy</a></b></td>
 180
 181 <td><tt>String</tt></td>
 182
 183 <td><tt>1.0.2</tt></td>
 184
 185 <td>Hibernate Naming Strategy<br /><b>User property is</b>: <tt>hibernate.ejb.naming_strategy</tt>.</td>
 186           </tr>
 187
 188 <tr class="b">
 189
 190 <td><b><a href="#hibernateProperties">hibernateProperties</a></b></td>
 191
 192 <td><tt>String</tt></td>
 193
 194 <td><tt>1.0</tt></td>
 195
 196 <td>Path to Hibernate configuration file.<br /><b>Default value is</b>: <tt>${project.build.outputDirectory}/hibernate.properties</tt>.<br /></td>
 197           </tr>
 198
 199 <tr class="a">
 200
 201 <td><b><a href="#outputDirectory">outputDirectory</a></b></td>
 202
 203 <td><tt>String</tt></td>
 204
 205 <td><tt>1.0</tt></td>
 206
 207 <td>Classes-Directory to scan.
 208
 209 <p>This parameter defaults to the maven build-output-directory for
 210 classes. Additionally, all dependencies are scanned for annotated
 211 classes.</p><br /><b>User property is</b>: <tt>project.build.outputDirectory</tt>.</td>
 212           </tr>
 213
 214 <tr class="b">
 215
 216 <td><b><a href="#outputFile">outputFile</a></b></td>
 217
 218 <td><tt>String</tt></td>
 219
 220 <td><tt>1.0</tt></td>
 221
 222 <td>Output file.<br /><b>Default value is</b>: <tt>${project.build.directory}/schema.sql</tt>.<br /><b>User property is</b>: <tt>hibernate.export.schema.filename</tt>.</td>
 223           </tr>
 224
 225 <tr class="a">
 226
 227 <td><b><a href="#password">password</a></b></td>
 228
 229 <td><tt>String</tt></td>
 230
 231 <td><tt>1.0</tt></td>
 232
 233 <td>Database password<br /><b>User property is</b>: <tt>hibernate.connection.password</tt>.</td>
 234           </tr>
 235
 236 <tr class="b">
 237
 238 <td><b><a href="#scanDependencies">scanDependencies</a></b></td>
 239
 240 <td><tt>String</tt></td>
 241
 242 <td><tt>1.0.3</tt></td>
 243
 244 <td>Dependency-Scopes, that should be scanned for annotated classes.
 245
 246 <p>By default, only dependencies in the scope <tt>compile</tt>
 247 are scanned for annotated classes. Multiple scopes can be seperated
 248 by white space or commas.</p>
 249
 250 <p>If you do not want any dependencies to be scanned for annotated
 251 classes, set this parameter to <tt>none</tt>.</p>
 252
 253 <p>The plugin does not scan for annotated classes in transitive
 254 dependencies. If some of your annotated classes are hidden in a
 255 transitive dependency, you can simply add that dependency
 256 explicitly.</p><br /><b>Default value is</b>: <tt>compile</tt>.<br /><b>User property is</b>: <tt>hibernate.export.scan_dependencies</tt>.</td>
 257           </tr>
 258
 259 <tr class="a">
 260
 261 <td><b><a href="#scanTestClasses">scanTestClasses</a></b></td>
 262
 263 <td><tt>boolean</tt></td>
 264
 265 <td><tt>1.0.1</tt></td>
 266
 267 <td>Whether to scan test-classes too, or not.
 268
 269 <p>If this parameter is set to <tt>true</tt> the test-classes
 270 of the artifact will be scanned for hibernate-annotated classes
 271 additionally.</p><br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>hibernate.export.scan_testclasses</tt>.</td>
 272           </tr>
 273
 274 <tr class="b">
 275
 276 <td><b><a href="#skip">skip</a></b></td>
 277
 278 <td><tt>boolean</tt></td>
 279
 280 <td><tt>1.0</tt></td>
 281
 282 <td>Skip execution
 283
 284 <p>If set to <tt>true</tt>, the execution is skipped.</p>
 285
 286 <p>A skipped execution is signaled via the maven-property
 287 <tt>${hibernate.export.skipped}</tt>.</p>
 288
 289 <p>The execution is skipped automatically, if no modified or newly
 290 added annotated classes are found and the dialect was not
 291 changed.</p><br /><b>Default value is</b>: <tt>${maven.test.skip}</tt>.<br /><b>User property is</b>: <tt>hibernate.skip</tt>.</td>
 292           </tr>
 293
 294 <tr class="a">
 295
 296 <td><b><a href="#target">target</a></b></td>
 297
 298 <td><tt>String</tt></td>
 299
 300 <td><tt>1.0</tt></td>
 301
 302 <td>Target of execution:
 303
 304 <ul>
 305
 306 <li><b>NONE</b> only export schema to SQL-script (forces
 307 execution, signals skip)</li>
 308
 309 <li><b>EXPORT</b> create database
 310 (<b>DEFAULT!</b>). forces execution, signals skip)</li>
 311
 312 <li><b>SCRIPT</b> export schema to SQL-script and print
 313 it to STDOUT</li>
 314
 315 <li><b>BOTH</b></li>
 316 </ul>
 317 A database connection is only needed for EXPORT and BOTH, but a
 318 Hibernate-Dialect must always be chosen.<br /><b>Default value is</b>: <tt>EXPORT</tt>.<br /><b>User property is</b>: <tt>hibernate.export.target</tt>.</td>
 319           </tr>
 320
 321 <tr class="b">
 322
 323 <td><b><a href="#testOutputDirectory">testOutputDirectory</a></b></td>
 324
 325 <td><tt>String</tt></td>
 326
 327 <td><tt>1.0.2</tt></td>
 328
 329 <td>Test-Classes-Directory to scan.
 330
 331 <p>This parameter defaults to the maven build-output-directory for
 332 test-classes.</p>
 333
 334 <p>This parameter is only used, when <tt>scanTestClasses</tt>
 335 is set to <tt>true</tt>!</p><br /><b>User property is</b>: <tt>project.build.testOutputDirectory</tt>.</td>
 336           </tr>
 337
 338 <tr class="a">
 339
 340 <td><b><a href="#type">type</a></b></td>
 341
 342 <td><tt>String</tt></td>
 343
 344 <td><tt>1.0</tt></td>
 345
 346 <td>Type of execution.
 347
 348 <ul>
 349
 350 <li><b>NONE</b> do nothing - just validate the
 351 configuration</li>
 352
 353 <li><b>CREATE</b> create database-schema</li>
 354
 355 <li><b>DROP</b> drop database-schema</li>
 356
 357 <li><b>BOTH</b> (<b>DEFAULT!</b>)</li>
 358 </ul>
 359 If NONE is choosen, no databaseconnection is needed.<br /><b>Default value is</b>: <tt>BOTH</tt>.<br /><b>User property is</b>: <tt>hibernate.export.type</tt>.</td>
 360           </tr>
 361
 362 <tr class="b">
 363
 364 <td><b><a href="#url">url</a></b></td>
 365
 366 <td><tt>String</tt></td>
 367
 368 <td><tt>1.0</tt></td>
 369
 370 <td>Database URL.<br /><b>User property is</b>: <tt>hibernate.connection.url</tt>.</td>
 371           </tr>
 372
 373 <tr class="a">
 374
 375 <td><b><a href="#username">username</a></b></td>
 376
 377 <td><tt>String</tt></td>
 378
 379 <td><tt>1.0</tt></td>
 380
 381 <td>Database username<br /><b>User property is</b>: <tt>hibernate.connection.username</tt>.</td>
 382           </tr>
 383         </table>
 384       </div>
 385
 386 <div class="section">
 387 <h3>Parameter Details<a name="Parameter_Details"></a></h3>
 388
 389 <p><b><a name="delimiter">delimiter</a>:</b></p>
 390
 391 <div>Delimiter in output-file.</div>
 392
 393 <ul>
 394
 395 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 396
 397 <li><b>Since</b>: <tt>1.0</tt></li>
 398
 399 <li><b>Required</b>: <tt>No</tt></li>
 400
 401 <li><b>User Property</b>: <tt>hibernate.export.schema.delimiter</tt></li>
 402
 403 <li><b>Default</b>: <tt>;</tt></li>
 404         </ul><hr />
 405 <p><b><a name="driverClassName">driverClassName</a>:</b></p>
 406
 407 <div>SQL-Driver name.</div>
 408
 409 <ul>
 410
 411 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 412
 413 <li><b>Since</b>: <tt>1.0</tt></li>
 414
 415 <li><b>Required</b>: <tt>No</tt></li>
 416
 417 <li><b>User Property</b>: <tt>hibernate.connection.driver_class</tt></li>
 418         </ul><hr />
 419 <p><b><a name="envers">envers</a>:</b></p>
 420
 421 <div>Generate envers schema for auditing tables.</div>
 422
 423 <ul>
 424
 425 <li><b>Type</b>: <tt>boolean</tt></li>
 426
 427 <li><b>Since</b>: <tt>1.0.3</tt></li>
 428
 429 <li><b>Required</b>: <tt>No</tt></li>
 430
 431 <li><b>User Property</b>: <tt>hibernate.export.envers</tt></li>
 432
 433 <li><b>Default</b>: <tt>false</tt></li>
 434         </ul><hr />
 435 <p><b><a name="force">force</a>:</b></p>
 436
 437 <div>Force execution
 438
 439 <p>Force execution, even if no modified or newly added annotated
 440 classes where found and the dialect was not changed.</p>
 441
 442 <p><tt>skip</tt> takes precedence over <tt>force</tt>.</p></div>
 443
 444 <ul>
 445
 446 <li><b>Type</b>: <tt>boolean</tt></li>
 447
 448 <li><b>Since</b>: <tt>1.0</tt></li>
 449
 450 <li><b>Required</b>: <tt>No</tt></li>
 451
 452 <li><b>User Property</b>: <tt>hibernate.export.force</tt></li>
 453
 454 <li><b>Default</b>: <tt>false</tt></li>
 455         </ul><hr />
 456 <p><b><a name="format">format</a>:</b></p>
 457
 458 <div>Format output-file.</div>
 459
 460 <ul>
 461
 462 <li><b>Type</b>: <tt>boolean</tt></li>
 463
 464 <li><b>Since</b>: <tt>1.0</tt></li>
 465
 466 <li><b>Required</b>: <tt>No</tt></li>
 467
 468 <li><b>User Property</b>: <tt>hibernate.export.schema.format</tt></li>
 469
 470 <li><b>Default</b>: <tt>true</tt></li>
 471         </ul><hr />
 472 <p><b><a name="hibernateDialect">hibernateDialect</a>:</b></p>
 473
 474 <div>Hibernate dialect.</div>
 475
 476 <ul>
 477
 478 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 479
 480 <li><b>Since</b>: <tt>1.0</tt></li>
 481
 482 <li><b>Required</b>: <tt>No</tt></li>
 483
 484 <li><b>User Property</b>: <tt>hibernate.dialect</tt></li>
 485         </ul><hr />
 486 <p><b><a name="hibernateMapping">hibernateMapping</a>:</b></p>
 487
 488 <div>List of Hibernate-Mapping-Files (XML). Multiple files can be
 489 separated with white-spaces and/or commas.</div>
 490
 491 <ul>
 492
 493 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 494
 495 <li><b>Since</b>: <tt>1.0.2</tt></li>
 496
 497 <li><b>Required</b>: <tt>No</tt></li>
 498
 499 <li><b>User Property</b>: <tt>hibernate.mapping</tt></li>
 500         </ul><hr />
 501 <p><b><a name="hibernateNamingStrategy">hibernateNamingStrategy</a>:</b></p>
 502
 503 <div>Hibernate Naming Strategy</div>
 504
 505 <ul>
 506
 507 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 508
 509 <li><b>Since</b>: <tt>1.0.2</tt></li>
 510
 511 <li><b>Required</b>: <tt>No</tt></li>
 512
 513 <li><b>User Property</b>: <tt>hibernate.ejb.naming_strategy</tt></li>
 514         </ul><hr />
 515 <p><b><a name="hibernateProperties">hibernateProperties</a>:</b></p>
 516
 517 <div>Path to Hibernate configuration file.</div>
 518
 519 <ul>
 520
 521 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 522
 523 <li><b>Since</b>: <tt>1.0</tt></li>
 524
 525 <li><b>Required</b>: <tt>No</tt></li>
 526
 527 <li><b>Default</b>: <tt>${project.build.outputDirectory}/hibernate.properties</tt></li>
 528         </ul><hr />
 529 <p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
 530
 531 <div>Classes-Directory to scan.
 532
 533 <p>This parameter defaults to the maven build-output-directory for
 534 classes. Additionally, all dependencies are scanned for annotated
 535 classes.</p></div>
 536
 537 <ul>
 538
 539 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 540
 541 <li><b>Since</b>: <tt>1.0</tt></li>
 542
 543 <li><b>Required</b>: <tt>No</tt></li>
 544
 545 <li><b>User Property</b>: <tt>project.build.outputDirectory</tt></li>
 546         </ul><hr />
 547 <p><b><a name="outputFile">outputFile</a>:</b></p>
 548
 549 <div>Output file.</div>
 550
 551 <ul>
 552
 553 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 554
 555 <li><b>Since</b>: <tt>1.0</tt></li>
 556
 557 <li><b>Required</b>: <tt>No</tt></li>
 558
 559 <li><b>User Property</b>: <tt>hibernate.export.schema.filename</tt></li>
 560
 561 <li><b>Default</b>: <tt>${project.build.directory}/schema.sql</tt></li>
 562         </ul><hr />
 563 <p><b><a name="password">password</a>:</b></p>
 564
 565 <div>Database password</div>
 566
 567 <ul>
 568
 569 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 570
 571 <li><b>Since</b>: <tt>1.0</tt></li>
 572
 573 <li><b>Required</b>: <tt>No</tt></li>
 574
 575 <li><b>User Property</b>: <tt>hibernate.connection.password</tt></li>
 576         </ul><hr />
 577 <p><b><a name="scanDependencies">scanDependencies</a>:</b></p>
 578
 579 <div>Dependency-Scopes, that should be scanned for annotated classes.
 580
 581 <p>By default, only dependencies in the scope <tt>compile</tt>
 582 are scanned for annotated classes. Multiple scopes can be seperated
 583 by white space or commas.</p>
 584
 585 <p>If you do not want any dependencies to be scanned for annotated
 586 classes, set this parameter to <tt>none</tt>.</p>
 587
 588 <p>The plugin does not scan for annotated classes in transitive
 589 dependencies. If some of your annotated classes are hidden in a
 590 transitive dependency, you can simply add that dependency
 591 explicitly.</p></div>
 592
 593 <ul>
 594
 595 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 596
 597 <li><b>Since</b>: <tt>1.0.3</tt></li>
 598
 599 <li><b>Required</b>: <tt>No</tt></li>
 600
 601 <li><b>User Property</b>: <tt>hibernate.export.scan_dependencies</tt></li>
 602
 603 <li><b>Default</b>: <tt>compile</tt></li>
 604         </ul><hr />
 605 <p><b><a name="scanTestClasses">scanTestClasses</a>:</b></p>
 606
 607 <div>Whether to scan test-classes too, or not.
 608
 609 <p>If this parameter is set to <tt>true</tt> the test-classes
 610 of the artifact will be scanned for hibernate-annotated classes
 611 additionally.</p></div>
 612
 613 <ul>
 614
 615 <li><b>Type</b>: <tt>boolean</tt></li>
 616
 617 <li><b>Since</b>: <tt>1.0.1</tt></li>
 618
 619 <li><b>Required</b>: <tt>No</tt></li>
 620
 621 <li><b>User Property</b>: <tt>hibernate.export.scan_testclasses</tt></li>
 622
 623 <li><b>Default</b>: <tt>false</tt></li>
 624         </ul><hr />
 625 <p><b><a name="skip">skip</a>:</b></p>
 626
 627 <div>Skip execution
 628
 629 <p>If set to <tt>true</tt>, the execution is skipped.</p>
 630
 631 <p>A skipped execution is signaled via the maven-property
 632 <tt>${hibernate.export.skipped}</tt>.</p>
 633
 634 <p>The execution is skipped automatically, if no modified or newly
 635 added annotated classes are found and the dialect was not
 636 changed.</p></div>
 637
 638 <ul>
 639
 640 <li><b>Type</b>: <tt>boolean</tt></li>
 641
 642 <li><b>Since</b>: <tt>1.0</tt></li>
 643
 644 <li><b>Required</b>: <tt>No</tt></li>
 645
 646 <li><b>User Property</b>: <tt>hibernate.skip</tt></li>
 647
 648 <li><b>Default</b>: <tt>${maven.test.skip}</tt></li>
 649         </ul><hr />
 650 <p><b><a name="target">target</a>:</b></p>
 651
 652 <div>Target of execution:
 653
 654 <ul>
 655
 656 <li><b>NONE</b> only export schema to SQL-script (forces
 657 execution, signals skip)</li>
 658
 659 <li><b>EXPORT</b> create database
 660 (<b>DEFAULT!</b>). forces execution, signals skip)</li>
 661
 662 <li><b>SCRIPT</b> export schema to SQL-script and print
 663 it to STDOUT</li>
 664
 665 <li><b>BOTH</b></li>
 666 </ul>
 667 A database connection is only needed for EXPORT and BOTH, but a
 668 Hibernate-Dialect must always be chosen.</div>
 669
 670 <ul>
 671
 672 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 673
 674 <li><b>Since</b>: <tt>1.0</tt></li>
 675
 676 <li><b>Required</b>: <tt>No</tt></li>
 677
 678 <li><b>User Property</b>: <tt>hibernate.export.target</tt></li>
 679
 680 <li><b>Default</b>: <tt>EXPORT</tt></li>
 681         </ul><hr />
 682 <p><b><a name="testOutputDirectory">testOutputDirectory</a>:</b></p>
 683
 684 <div>Test-Classes-Directory to scan.
 685
 686 <p>This parameter defaults to the maven build-output-directory for
 687 test-classes.</p>
 688
 689 <p>This parameter is only used, when <tt>scanTestClasses</tt>
 690 is set to <tt>true</tt>!</p></div>
 691
 692 <ul>
 693
 694 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 695
 696 <li><b>Since</b>: <tt>1.0.2</tt></li>
 697
 698 <li><b>Required</b>: <tt>No</tt></li>
 699
 700 <li><b>User Property</b>: <tt>project.build.testOutputDirectory</tt></li>
 701         </ul><hr />
 702 <p><b><a name="type">type</a>:</b></p>
 703
 704 <div>Type of execution.
 705
 706 <ul>
 707
 708 <li><b>NONE</b> do nothing - just validate the
 709 configuration</li>
 710
 711 <li><b>CREATE</b> create database-schema</li>
 712
 713 <li><b>DROP</b> drop database-schema</li>
 714
 715 <li><b>BOTH</b> (<b>DEFAULT!</b>)</li>
 716 </ul>
 717 If NONE is choosen, no databaseconnection is needed.</div>
 718
 719 <ul>
 720
 721 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 722
 723 <li><b>Since</b>: <tt>1.0</tt></li>
 724
 725 <li><b>Required</b>: <tt>No</tt></li>
 726
 727 <li><b>User Property</b>: <tt>hibernate.export.type</tt></li>
 728
 729 <li><b>Default</b>: <tt>BOTH</tt></li>
 730         </ul><hr />
 731 <p><b><a name="url">url</a>:</b></p>
 732
 733 <div>Database URL.</div>
 734
 735 <ul>
 736
 737 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 738
 739 <li><b>Since</b>: <tt>1.0</tt></li>
 740
 741 <li><b>Required</b>: <tt>No</tt></li>
 742
 743 <li><b>User Property</b>: <tt>hibernate.connection.url</tt></li>
 744         </ul><hr />
 745 <p><b><a name="username">username</a>:</b></p>
 746
 747 <div>Database username</div>
 748
 749 <ul>
 750
 751 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 752
 753 <li><b>Since</b>: <tt>1.0</tt></li>
 754
 755 <li><b>Required</b>: <tt>No</tt></li>
 756
 757 <li><b>User Property</b>: <tt>hibernate.connection.username</tt></li>
 758         </ul>
 759       </div>
 760     </div>
 761
 762
 763         </article>
 764         <div class="marginal">
 765           <nav id="nav">
 766             <hr class="n" />
 767             <a id="navigation"></a>
 768             <a class="hide" href="#top" title="Show Content">Jump back to the top of the page</a>
 769             <h2 class="nav menu">Section-Menu</h2>
 770             <ul id="menu">
 771               <li class="m blog"><a href="/blog/" class="m">Blog</a></li>
 772               <li class="m projects"><a href="/projects.html" class="m selected">Projects</a></li>
 773               <li class="m about"><a href="/about.html" class="m">About</a></li>
 774             </ul>
 775             <h2 class="nav submenu">
 776               <span class="s">Submenu for section</span>
 777               <a class="s selected" href="/projects.html">Projects</a>
 778             </h2>
 779             <ul id="submenu" class="s">
 780                                                               <li class="s sub">
 781                                           <a class="s selected" href="./index.html">Hibernate 4 Maven Plugin</a>
 782                                         <ul class="s active">
 783                                                                                                                                                                                                                                                           <li class="s">
 784                     <a href="configuration.html" class="s" title="Configuration Examples">Configuration Examples</a>
 785                 </li>
 786                                                                                                                         <li class="s">
 787               <strong class="s">Parameter Documentation</strong>
 788                 </li>
 789                                                                                                                   <li class="s">
 790                     <a href="debugging.html" class="s" title="Enable Debug-Output">Enable Debug-Output</a>
 791                 </li>
 792                                                                                                                   <li class="s">
 793                     <a href="skip.html" class="s" title="Skipping Execution">Skipping Execution</a>
 794                 </li>
 795                                                                                                                   <li class="s">
 796                     <a href="force.html" class="s" title="Force Exceution">Force Exceution</a>
 797                 </li>
 798                                                                                                                   <li class="s">
 799                     <a href="pitfalls.html" class="s" title="Known Pitfalls (FAQ)">Known Pitfalls (FAQ)</a>
 800                 </li>
 801                                                                                                                                                                                                                                                                                                                                                   <li class="s sub">
 802                     <a href="project-info.html" class="s" title="Project Information">Project Information</a>
 803                 </li>
 804                                                                                                                                                                                                   <li class="s sub">
 805                     <a href="project-reports.html" class="s" title="Project Reports">Project Reports</a>
 806                 </li>
 807                                                                                               </ul>
 808                   </li>
 809                                           </ul>
 810             <hr class="n" />
 811           </nav>
 812           <aside class="m">
 813             <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
 814               <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
 815             </a>
 816           </aside>
 817         </div>
 818       </main>
 819       <footer id="footer">
 820         <hr class="f" />
 821         <ul id="footerlinks">
 822           <li class="f" id="copyright">&#xa9; <strong>mo</strong>             2014
 823       </li>
 824           <li class="f"><a class="f" href="/impressum.html">Impressum</a></li>
 825           <li class="f about"><a class="f" href="/about.html">About</a></li>
 826         </ul>
 827       </footer>
 828     </div>
 829         <script type="text/javascript"><!--//--><![CDATA[//><!--
 830       var _gaq = _gaq || [];
 831       _gaq.push(['_setAccount', 'UA-571104-3']);
 832       _gaq.push(['_trackPageview']);
 833       (function() {
 834         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 835         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 836         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 837       })();
 838     //--><!]]>
 839     </script>
 840       </body>
 841 </html>