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

   1 <!DOCTYPE html>
   2 <!-- Generated by Apache Maven Doxia Site Renderer 1.4 at 2014-06-02 -->
   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.4: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>The plugin does not scan for annotated classes in transitive
 251 dependencies. If some of your annotated classes are hidden in a
 252 transitive dependency, you can simply add that dependency
 253 explicitly.</p><br /><b>Default value is</b>: <tt>compile</tt>.<br /><b>User property is</b>: <tt>hibernate.export.scan_dependencies</tt>.</td>
 254           </tr>
 255
 256 <tr class="a">
 257
 258 <td><b><a href="#scanTestClasses">scanTestClasses</a></b></td>
 259
 260 <td><tt>boolean</tt></td>
 261
 262 <td><tt>1.0.1</tt></td>
 263
 264 <td>Whether to scan test-classes too, or not.
 265
 266 <p>If this parameter is set to <tt>true</tt> the test-classes
 267 of the artifact will be scanned for hibernate-annotated classes
 268 additionally.</p><br /><b>Default value is</b>: <tt>false</tt>.<br /><b>User property is</b>: <tt>hibernate.export.scan_testclasses</tt>.</td>
 269           </tr>
 270
 271 <tr class="b">
 272
 273 <td><b><a href="#skip">skip</a></b></td>
 274
 275 <td><tt>boolean</tt></td>
 276
 277 <td><tt>1.0</tt></td>
 278
 279 <td>Skip execution
 280
 281 <p>If set to <tt>true</tt>, the execution is skipped.</p>
 282
 283 <p>A skipped execution is signaled via the maven-property
 284 <tt>${hibernate.export.skipped}</tt>.</p>
 285
 286 <p>The execution is skipped automatically, if no modified or newly
 287 added annotated classes are found and the dialect was not
 288 changed.</p><br /><b>Default value is</b>: <tt>${maven.test.skip}</tt>.<br /><b>User property is</b>: <tt>hibernate.skip</tt>.</td>
 289           </tr>
 290
 291 <tr class="a">
 292
 293 <td><b><a href="#target">target</a></b></td>
 294
 295 <td><tt>String</tt></td>
 296
 297 <td><tt>1.0</tt></td>
 298
 299 <td>Target of execution:
 300
 301 <ul>
 302
 303 <li><b>NONE</b> only export schema to SQL-script (forces
 304 execution, signals skip)</li>
 305
 306 <li><b>EXPORT</b> create database
 307 (<b>DEFAULT!</b>). forces execution, signals skip)</li>
 308
 309 <li><b>SCRIPT</b> export schema to SQL-script and print
 310 it to STDOUT</li>
 311
 312 <li><b>BOTH</b></li>
 313 </ul>
 314 A database connection is only needed for EXPORT and BOTH, but a
 315 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>
 316           </tr>
 317
 318 <tr class="b">
 319
 320 <td><b><a href="#testOutputDirectory">testOutputDirectory</a></b></td>
 321
 322 <td><tt>String</tt></td>
 323
 324 <td><tt>1.0.2</tt></td>
 325
 326 <td>Test-Classes-Directory to scan.
 327
 328 <p>This parameter defaults to the maven build-output-directory for
 329 test-classes.</p>
 330
 331 <p>This parameter is only used, when <tt>scanTestClasses</tt>
 332 is set to <tt>true</tt>!</p><br /><b>User property is</b>: <tt>project.build.testOutputDirectory</tt>.</td>
 333           </tr>
 334
 335 <tr class="a">
 336
 337 <td><b><a href="#type">type</a></b></td>
 338
 339 <td><tt>String</tt></td>
 340
 341 <td><tt>1.0</tt></td>
 342
 343 <td>Type of execution.
 344
 345 <ul>
 346
 347 <li><b>NONE</b> do nothing - just validate the
 348 configuration</li>
 349
 350 <li><b>CREATE</b> create database-schema</li>
 351
 352 <li><b>DROP</b> drop database-schema</li>
 353
 354 <li><b>BOTH</b> (<b>DEFAULT!</b>)</li>
 355 </ul>
 356 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>
 357           </tr>
 358
 359 <tr class="b">
 360
 361 <td><b><a href="#url">url</a></b></td>
 362
 363 <td><tt>String</tt></td>
 364
 365 <td><tt>1.0</tt></td>
 366
 367 <td>Database URL.<br /><b>User property is</b>: <tt>hibernate.connection.url</tt>.</td>
 368           </tr>
 369
 370 <tr class="a">
 371
 372 <td><b><a href="#username">username</a></b></td>
 373
 374 <td><tt>String</tt></td>
 375
 376 <td><tt>1.0</tt></td>
 377
 378 <td>Database username<br /><b>User property is</b>: <tt>hibernate.connection.username</tt>.</td>
 379           </tr>
 380         </table>
 381       </div>
 382
 383 <div class="section">
 384 <h3>Parameter Details<a name="Parameter_Details"></a></h3>
 385
 386 <p><b><a name="delimiter">delimiter</a>:</b></p>
 387
 388 <div>Delimiter in output-file.</div>
 389
 390 <ul>
 391
 392 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 393
 394 <li><b>Since</b>: <tt>1.0</tt></li>
 395
 396 <li><b>Required</b>: <tt>No</tt></li>
 397
 398 <li><b>User Property</b>: <tt>hibernate.export.schema.delimiter</tt></li>
 399
 400 <li><b>Default</b>: <tt>;</tt></li>
 401         </ul><hr />
 402 <p><b><a name="driverClassName">driverClassName</a>:</b></p>
 403
 404 <div>SQL-Driver name.</div>
 405
 406 <ul>
 407
 408 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 409
 410 <li><b>Since</b>: <tt>1.0</tt></li>
 411
 412 <li><b>Required</b>: <tt>No</tt></li>
 413
 414 <li><b>User Property</b>: <tt>hibernate.connection.driver_class</tt></li>
 415         </ul><hr />
 416 <p><b><a name="envers">envers</a>:</b></p>
 417
 418 <div>Generate envers schema for auditing tables.</div>
 419
 420 <ul>
 421
 422 <li><b>Type</b>: <tt>boolean</tt></li>
 423
 424 <li><b>Since</b>: <tt>1.0.3</tt></li>
 425
 426 <li><b>Required</b>: <tt>No</tt></li>
 427
 428 <li><b>User Property</b>: <tt>hibernate.export.envers</tt></li>
 429
 430 <li><b>Default</b>: <tt>false</tt></li>
 431         </ul><hr />
 432 <p><b><a name="force">force</a>:</b></p>
 433
 434 <div>Force execution
 435
 436 <p>Force execution, even if no modified or newly added annotated
 437 classes where found and the dialect was not changed.</p>
 438
 439 <p><tt>skip</tt> takes precedence over <tt>force</tt>.</p></div>
 440
 441 <ul>
 442
 443 <li><b>Type</b>: <tt>boolean</tt></li>
 444
 445 <li><b>Since</b>: <tt>1.0</tt></li>
 446
 447 <li><b>Required</b>: <tt>No</tt></li>
 448
 449 <li><b>User Property</b>: <tt>hibernate.export.force</tt></li>
 450
 451 <li><b>Default</b>: <tt>false</tt></li>
 452         </ul><hr />
 453 <p><b><a name="format">format</a>:</b></p>
 454
 455 <div>Format output-file.</div>
 456
 457 <ul>
 458
 459 <li><b>Type</b>: <tt>boolean</tt></li>
 460
 461 <li><b>Since</b>: <tt>1.0</tt></li>
 462
 463 <li><b>Required</b>: <tt>No</tt></li>
 464
 465 <li><b>User Property</b>: <tt>hibernate.export.schema.format</tt></li>
 466
 467 <li><b>Default</b>: <tt>true</tt></li>
 468         </ul><hr />
 469 <p><b><a name="hibernateDialect">hibernateDialect</a>:</b></p>
 470
 471 <div>Hibernate dialect.</div>
 472
 473 <ul>
 474
 475 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 476
 477 <li><b>Since</b>: <tt>1.0</tt></li>
 478
 479 <li><b>Required</b>: <tt>No</tt></li>
 480
 481 <li><b>User Property</b>: <tt>hibernate.dialect</tt></li>
 482         </ul><hr />
 483 <p><b><a name="hibernateMapping">hibernateMapping</a>:</b></p>
 484
 485 <div>List of Hibernate-Mapping-Files (XML). Multiple files can be
 486 separated with white-spaces and/or commas.</div>
 487
 488 <ul>
 489
 490 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 491
 492 <li><b>Since</b>: <tt>1.0.2</tt></li>
 493
 494 <li><b>Required</b>: <tt>No</tt></li>
 495
 496 <li><b>User Property</b>: <tt>hibernate.mapping</tt></li>
 497         </ul><hr />
 498 <p><b><a name="hibernateNamingStrategy">hibernateNamingStrategy</a>:</b></p>
 499
 500 <div>Hibernate Naming Strategy</div>
 501
 502 <ul>
 503
 504 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 505
 506 <li><b>Since</b>: <tt>1.0.2</tt></li>
 507
 508 <li><b>Required</b>: <tt>No</tt></li>
 509
 510 <li><b>User Property</b>: <tt>hibernate.ejb.naming_strategy</tt></li>
 511         </ul><hr />
 512 <p><b><a name="hibernateProperties">hibernateProperties</a>:</b></p>
 513
 514 <div>Path to Hibernate configuration file.</div>
 515
 516 <ul>
 517
 518 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 519
 520 <li><b>Since</b>: <tt>1.0</tt></li>
 521
 522 <li><b>Required</b>: <tt>No</tt></li>
 523
 524 <li><b>Default</b>: <tt>${project.build.outputDirectory}/hibernate.properties</tt></li>
 525         </ul><hr />
 526 <p><b><a name="outputDirectory">outputDirectory</a>:</b></p>
 527
 528 <div>Classes-Directory to scan.
 529
 530 <p>This parameter defaults to the maven build-output-directory for
 531 classes. Additionally, all dependencies are scanned for annotated
 532 classes.</p></div>
 533
 534 <ul>
 535
 536 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 537
 538 <li><b>Since</b>: <tt>1.0</tt></li>
 539
 540 <li><b>Required</b>: <tt>No</tt></li>
 541
 542 <li><b>User Property</b>: <tt>project.build.outputDirectory</tt></li>
 543         </ul><hr />
 544 <p><b><a name="outputFile">outputFile</a>:</b></p>
 545
 546 <div>Output file.</div>
 547
 548 <ul>
 549
 550 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 551
 552 <li><b>Since</b>: <tt>1.0</tt></li>
 553
 554 <li><b>Required</b>: <tt>No</tt></li>
 555
 556 <li><b>User Property</b>: <tt>hibernate.export.schema.filename</tt></li>
 557
 558 <li><b>Default</b>: <tt>${project.build.directory}/schema.sql</tt></li>
 559         </ul><hr />
 560 <p><b><a name="password">password</a>:</b></p>
 561
 562 <div>Database password</div>
 563
 564 <ul>
 565
 566 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 567
 568 <li><b>Since</b>: <tt>1.0</tt></li>
 569
 570 <li><b>Required</b>: <tt>No</tt></li>
 571
 572 <li><b>User Property</b>: <tt>hibernate.connection.password</tt></li>
 573         </ul><hr />
 574 <p><b><a name="scanDependencies">scanDependencies</a>:</b></p>
 575
 576 <div>Dependency-Scopes, that should be scanned for annotated classes.
 577
 578 <p>By default, only dependencies in the scope <tt>compile</tt>
 579 are scanned for annotated classes. Multiple scopes can be seperated
 580 by white space or commas.</p>
 581
 582 <p>The plugin does not scan for annotated classes in transitive
 583 dependencies. If some of your annotated classes are hidden in a
 584 transitive dependency, you can simply add that dependency
 585 explicitly.</p></div>
 586
 587 <ul>
 588
 589 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 590
 591 <li><b>Since</b>: <tt>1.0.3</tt></li>
 592
 593 <li><b>Required</b>: <tt>No</tt></li>
 594
 595 <li><b>User Property</b>: <tt>hibernate.export.scan_dependencies</tt></li>
 596
 597 <li><b>Default</b>: <tt>compile</tt></li>
 598         </ul><hr />
 599 <p><b><a name="scanTestClasses">scanTestClasses</a>:</b></p>
 600
 601 <div>Whether to scan test-classes too, or not.
 602
 603 <p>If this parameter is set to <tt>true</tt> the test-classes
 604 of the artifact will be scanned for hibernate-annotated classes
 605 additionally.</p></div>
 606
 607 <ul>
 608
 609 <li><b>Type</b>: <tt>boolean</tt></li>
 610
 611 <li><b>Since</b>: <tt>1.0.1</tt></li>
 612
 613 <li><b>Required</b>: <tt>No</tt></li>
 614
 615 <li><b>User Property</b>: <tt>hibernate.export.scan_testclasses</tt></li>
 616
 617 <li><b>Default</b>: <tt>false</tt></li>
 618         </ul><hr />
 619 <p><b><a name="skip">skip</a>:</b></p>
 620
 621 <div>Skip execution
 622
 623 <p>If set to <tt>true</tt>, the execution is skipped.</p>
 624
 625 <p>A skipped execution is signaled via the maven-property
 626 <tt>${hibernate.export.skipped}</tt>.</p>
 627
 628 <p>The execution is skipped automatically, if no modified or newly
 629 added annotated classes are found and the dialect was not
 630 changed.</p></div>
 631
 632 <ul>
 633
 634 <li><b>Type</b>: <tt>boolean</tt></li>
 635
 636 <li><b>Since</b>: <tt>1.0</tt></li>
 637
 638 <li><b>Required</b>: <tt>No</tt></li>
 639
 640 <li><b>User Property</b>: <tt>hibernate.skip</tt></li>
 641
 642 <li><b>Default</b>: <tt>${maven.test.skip}</tt></li>
 643         </ul><hr />
 644 <p><b><a name="target">target</a>:</b></p>
 645
 646 <div>Target of execution:
 647
 648 <ul>
 649
 650 <li><b>NONE</b> only export schema to SQL-script (forces
 651 execution, signals skip)</li>
 652
 653 <li><b>EXPORT</b> create database
 654 (<b>DEFAULT!</b>). forces execution, signals skip)</li>
 655
 656 <li><b>SCRIPT</b> export schema to SQL-script and print
 657 it to STDOUT</li>
 658
 659 <li><b>BOTH</b></li>
 660 </ul>
 661 A database connection is only needed for EXPORT and BOTH, but a
 662 Hibernate-Dialect must always be chosen.</div>
 663
 664 <ul>
 665
 666 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 667
 668 <li><b>Since</b>: <tt>1.0</tt></li>
 669
 670 <li><b>Required</b>: <tt>No</tt></li>
 671
 672 <li><b>User Property</b>: <tt>hibernate.export.target</tt></li>
 673
 674 <li><b>Default</b>: <tt>EXPORT</tt></li>
 675         </ul><hr />
 676 <p><b><a name="testOutputDirectory">testOutputDirectory</a>:</b></p>
 677
 678 <div>Test-Classes-Directory to scan.
 679
 680 <p>This parameter defaults to the maven build-output-directory for
 681 test-classes.</p>
 682
 683 <p>This parameter is only used, when <tt>scanTestClasses</tt>
 684 is set to <tt>true</tt>!</p></div>
 685
 686 <ul>
 687
 688 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 689
 690 <li><b>Since</b>: <tt>1.0.2</tt></li>
 691
 692 <li><b>Required</b>: <tt>No</tt></li>
 693
 694 <li><b>User Property</b>: <tt>project.build.testOutputDirectory</tt></li>
 695         </ul><hr />
 696 <p><b><a name="type">type</a>:</b></p>
 697
 698 <div>Type of execution.
 699
 700 <ul>
 701
 702 <li><b>NONE</b> do nothing - just validate the
 703 configuration</li>
 704
 705 <li><b>CREATE</b> create database-schema</li>
 706
 707 <li><b>DROP</b> drop database-schema</li>
 708
 709 <li><b>BOTH</b> (<b>DEFAULT!</b>)</li>
 710 </ul>
 711 If NONE is choosen, no databaseconnection is needed.</div>
 712
 713 <ul>
 714
 715 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 716
 717 <li><b>Since</b>: <tt>1.0</tt></li>
 718
 719 <li><b>Required</b>: <tt>No</tt></li>
 720
 721 <li><b>User Property</b>: <tt>hibernate.export.type</tt></li>
 722
 723 <li><b>Default</b>: <tt>BOTH</tt></li>
 724         </ul><hr />
 725 <p><b><a name="url">url</a>:</b></p>
 726
 727 <div>Database URL.</div>
 728
 729 <ul>
 730
 731 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 732
 733 <li><b>Since</b>: <tt>1.0</tt></li>
 734
 735 <li><b>Required</b>: <tt>No</tt></li>
 736
 737 <li><b>User Property</b>: <tt>hibernate.connection.url</tt></li>
 738         </ul><hr />
 739 <p><b><a name="username">username</a>:</b></p>
 740
 741 <div>Database username</div>
 742
 743 <ul>
 744
 745 <li><b>Type</b>: <tt>java.lang.String</tt></li>
 746
 747 <li><b>Since</b>: <tt>1.0</tt></li>
 748
 749 <li><b>Required</b>: <tt>No</tt></li>
 750
 751 <li><b>User Property</b>: <tt>hibernate.connection.username</tt></li>
 752         </ul>
 753       </div>
 754     </div>
 755
 756
 757         </article>
 758         <div class="marginal">
 759           <nav id="nav">
 760             <hr class="n" />
 761             <a id="navigation"></a>
 762             <a class="hide" href="#top" title="Show Content">Jump back to the top of the page</a>
 763             <h2 class="nav menu">Section-Menu</h2>
 764             <ul id="menu">
 765               <li class="m blog"><a href="/blog/" class="m">Blog</a></li>
 766               <li class="m projects"><a href="/projects.html" class="m selected">Projects</a></li>
 767               <li class="m about"><a href="/about.html" class="m">About</a></li>
 768             </ul>
 769             <h2 class="nav submenu">
 770               <span class="s">Submenu for section</span>
 771               <a class="s selected" href="/projects.html">Projects</a>
 772             </h2>
 773             <ul id="submenu" class="s">
 774                                                               <li class="s sub">
 775                                           <a class="s selected" href="./index.html">Hibernate 4 Maven Plugin</a>
 776                                         <ul class="s active">
 777                                                                                                                                                                                                                                                           <li class="s">
 778                     <a href="configuration.html" class="s" title="Configuration Examples">Configuration Examples</a>
 779                 </li>
 780                                                                                                                         <li class="s">
 781               <strong class="s">Parameter Documentation</strong>
 782                 </li>
 783                                                                                                                   <li class="s">
 784                     <a href="debugging.html" class="s" title="Enable Debug-Output">Enable Debug-Output</a>
 785                 </li>
 786                                                                                                                   <li class="s">
 787                     <a href="skip.html" class="s" title="Skipping Execution">Skipping Execution</a>
 788                 </li>
 789                                                                                                                   <li class="s">
 790                     <a href="force.html" class="s" title="Force Exceution">Force Exceution</a>
 791                 </li>
 792                                                                                                                   <li class="s">
 793                     <a href="pitfalls.html" class="s" title="Known Pitfalls (FAQ)">Known Pitfalls (FAQ)</a>
 794                 </li>
 795                                                                                                                                                                                                                                                                                                                                                   <li class="s sub">
 796                     <a href="project-info.html" class="s" title="Project Information">Project Information</a>
 797                 </li>
 798                                                                                                                                                                                                   <li class="s sub">
 799                     <a href="project-reports.html" class="s" title="Project Reports">Project Reports</a>
 800                 </li>
 801                                                                                               </ul>
 802                   </li>
 803                                           </ul>
 804             <hr class="n" />
 805           </nav>
 806           <aside class="m">
 807             <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
 808               <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
 809             </a>
 810           </aside>
 811         </div>
 812       </main>
 813       <footer id="footer">
 814         <hr class="f" />
 815         <ul id="footerlinks">
 816           <li class="f" id="copyright">&#xa9; <strong>mo</strong>             2014
 817       </li>
 818           <li class="f"><a class="f" href="/impressum.html">Impressum</a></li>
 819           <li class="f about"><a class="f" href="/about.html">About</a></li>
 820         </ul>
 821       </footer>
 822     </div>
 823         <script type="text/javascript"><!--//--><![CDATA[//><!--
 824       var _gaq = _gaq || [];
 825       _gaq.push(['_setAccount', 'UA-571104-3']);
 826       _gaq.push(['_trackPageview']);
 827       (function() {
 828         var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 829         ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 830         var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 831       })();
 832     //--><!]]>
 833     </script>
 834       </body>
 835 </html>