hibernate4:export

Full name:

de.juplo:hibernate4-maven-plugin:1.0.2:export

Description:

Goal which extracts the hibernate-mapping-configuration and exports an according SQL-database-schema.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: process-classes.

Optional Parameters

Name Type Since Description
delimiter String - Delimiter in output-file.
Default value is: ;.
User property is: hibernate.export.schema.delimiter.
driverClassName String - SQL-Driver name.
User property is: hibernate.connection.driver_class.
force boolean - Force execution

Force execution, even if no modified or newly added annotated classes where found and the dialect was not changed.

skip takes precedence over force.


Default value is: false.
User property is: hibernate.export.force.
format boolean - Format output-file.
Default value is: true.
User property is: hibernate.export.schema.format.
hibernateDialect String - Hibernate dialect.
User property is: hibernate.dialect.
hibernateMapping String - List of Hibernate-Mapping-Files (XML). Multiple files can be separated with white-spaces and/or commas.
User property is: hibernate.mapping.
hibernateNamingStrategy String - Hibernate Naming Strategy
User property is: hibernate.ejb.naming_strategy.
hibernateProperties String - Path to Hibernate configuration file.
Default value is: ${project.build.outputDirectory}/hibernate.properties.
outputDirectory String - Classes-Directory to scan.

This parameter defaults to the maven build-output-directory for classes. Additonally, all dependencies are scanned for annotated classes.


User property is: project.build.outputDirectory.
outputFile String - Output file.
Default value is: ${project.build.directory}/schema.sql.
User property is: hibernate.export.schema.filename.
password String - Database password
User property is: hibernate.connection.password.
scanTestClasses boolean - Wether to scan test-classes too, or not.

If this parameter is set to true the test-classes of the artifact will be scanned for hibernate-annotated classes additionally.


Default value is: false.
User property is: hibernate.export.scan_testclasses.
skip boolean - Skip execution

If set to true, the execution is skipped.

A skipped excecution is signaled via the maven-property ${hibernate.export.skipped}.

The excecution is skipped automatically, if no modified or newly added annotated classes are found and the dialect was not changed.


Default value is: false.
User property is: maven.test.skip.
target String - Target of execution:
  • NONE only export schema to SQL-script (forces excecution, signals skip)
  • EXPORT create database (DEFAULT!). forces excecution, signals skip)
  • SCRIPT export schema to SQL-script and print it to STDOUT
  • BOTH
A databaseconnection is only needed for EXPORT and BOTH, but a Hibernate-Dialect must always be choosen.
Default value is: EXPORT.
User property is: hibernate.export.target.
testOutputDirectory String - Test-Classes-Directory to scan.

This parameter defaults to the maven build-output-directory for test-classes.

This parameter is only used, when scanTestClasses is set to true!


User property is: project.build.testOutputDirectory.
type String - Type of execution.
  • NONE do nothing - just validate the configuration
  • CREATE create database-schema
  • DROP drop database-schema
  • BOTH (DEFAULT!)
If NONE is choosen, no databaseconnection is needed.
Default value is: BOTH.
User property is: hibernate.export.type.
url String - Database URL.
User property is: hibernate.connection.url.
username String - Database username
User property is: hibernate.connection.username.

Parameter Details

delimiter:

Delimiter in output-file.
  • Type: java.lang.String
  • Required: No
  • User Property: hibernate.export.schema.delimiter
  • Default: ;

driverClassName:

SQL-Driver name.
  • Type: java.lang.String
  • Required: No
  • User Property: hibernate.connection.driver_class

force:

Force execution

Force execution, even if no modified or newly added annotated classes where found and the dialect was not changed.

skip takes precedence over force.

  • Type: boolean
  • Required: No
  • User Property: hibernate.export.force
  • Default: false

format:

Format output-file.
  • Type: boolean
  • Required: No
  • User Property: hibernate.export.schema.format
  • Default: true

hibernateDialect:

Hibernate dialect.
  • Type: java.lang.String
  • Required: No
  • User Property: hibernate.dialect

hibernateMapping:

List of Hibernate-Mapping-Files (XML). Multiple files can be separated with white-spaces and/or commas.
  • Type: java.lang.String
  • Required: No
  • User Property: hibernate.mapping

hibernateNamingStrategy:

Hibernate Naming Strategy
  • Type: java.lang.String
  • Required: No
  • User Property: hibernate.ejb.naming_strategy

hibernateProperties:

Path to Hibernate configuration file.
  • Type: java.lang.String
  • Required: No
  • Default: ${project.build.outputDirectory}/hibernate.properties

outputDirectory:

Classes-Directory to scan.

This parameter defaults to the maven build-output-directory for classes. Additonally, all dependencies are scanned for annotated classes.

  • Type: java.lang.String
  • Required: No
  • User Property: project.build.outputDirectory

outputFile:

Output file.
  • Type: java.lang.String
  • Required: No
  • User Property: hibernate.export.schema.filename
  • Default: ${project.build.directory}/schema.sql

password:

Database password
  • Type: java.lang.String
  • Required: No
  • User Property: hibernate.connection.password

scanTestClasses:

Wether to scan test-classes too, or not.

If this parameter is set to true the test-classes of the artifact will be scanned for hibernate-annotated classes additionally.

  • Type: boolean
  • Required: No
  • User Property: hibernate.export.scan_testclasses
  • Default: false

skip:

Skip execution

If set to true, the execution is skipped.

A skipped excecution is signaled via the maven-property ${hibernate.export.skipped}.

The excecution is skipped automatically, if no modified or newly added annotated classes are found and the dialect was not changed.

  • Type: boolean
  • Required: No
  • User Property: maven.test.skip
  • Default: false

target:

Target of execution:
  • NONE only export schema to SQL-script (forces excecution, signals skip)
  • EXPORT create database (DEFAULT!). forces excecution, signals skip)
  • SCRIPT export schema to SQL-script and print it to STDOUT
  • BOTH
A databaseconnection is only needed for EXPORT and BOTH, but a Hibernate-Dialect must always be choosen.
  • Type: java.lang.String
  • Required: No
  • User Property: hibernate.export.target
  • Default: EXPORT

testOutputDirectory:

Test-Classes-Directory to scan.

This parameter defaults to the maven build-output-directory for test-classes.

This parameter is only used, when scanTestClasses is set to true!

  • Type: java.lang.String
  • Required: No
  • User Property: project.build.testOutputDirectory

type:

Type of execution.
  • NONE do nothing - just validate the configuration
  • CREATE create database-schema
  • DROP drop database-schema
  • BOTH (DEFAULT!)
If NONE is choosen, no databaseconnection is needed.
  • Type: java.lang.String
  • Required: No
  • User Property: hibernate.export.type
  • Default: BOTH

url:

Database URL.
  • Type: java.lang.String
  • Required: No
  • User Property: hibernate.connection.url

username:

Database username
  • Type: java.lang.String
  • Required: No
  • User Property: hibernate.connection.username