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

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