Fork me on GitHub
Built by Maven

hibernate52-ddl:gen-ddl

Full name:

de.jpdigital:hibernate52-ddl-maven-plugin:2.4.0-SNAPSHOT:gen-ddl

Description:

Provides a goal which creates DDL SQL files for the JPA entities in the project (using the Hibernate 5 SchemaExport class}. The actual logic is in GenerateDdlMojo, but without this class Maven does not find the goal.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: compile+runtime.
  • Binds by default to the lifecycle phase: process-classes.

Required Parameters

Name Type Since Description
<outputDirectory> File - Location of the output file.
Default value is: ${project.build.directory}/generated-resources/sql/ddl/auto.
User property is: outputDir.
<packages> String[] - Packages containing the entity files for which the SQL DDL scripts shall be generated.

Optional Parameters

Name Type Since Description
<createDropStatements> boolean - Set this to true to include drop statements into the generated DDL file.
<customDialects> String[] - (no description)
<dialects> String[] - Database dialects for which create scripts shall be generated. For available dialects refer to the documentation the Dialect enumeration.
<includeTestClasses> boolean - Set to true to include classes in src/test.
<omitDialectFromFileName> boolean - If set to true and if only one dialect is configured and either outputFileNamePrefix or outputFileNameSuffix are set the dialect name will be omitted from the name of the DDL file.
<outputFileNamePrefix> String - If set each name of an output file will be prefixed with the value of this parameter.
<outputFileNameSuffix> String - If set the value of this parameter will be appended to the name of each output file.
<persistencePropertiesToUse> String[] - (no description)
<persistenceXml> File - The persistence.xml file to use to read properties etc. Default value is src/main/resources/META-INF/persistence.xml. If the file is not present it is ignored. If the file is present all properties set using a <property> element are set on the Hibernate configuration.
Default value is: ${basedir}/src/main/resources/META-INF/persistence.xml.

Parameter Details

<createDropStatements>

Set this to true to include drop statements into the generated DDL file.
  • Type: boolean
  • Required: No

<customDialects>

(no description)
  • Type: java.lang.String[]
  • Required: No

<dialects>

Database dialects for which create scripts shall be generated. For available dialects refer to the documentation the Dialect enumeration.
  • Type: java.lang.String[]
  • Required: No

<includeTestClasses>

Set to true to include classes in src/test.
  • Type: boolean
  • Required: No

<omitDialectFromFileName>

If set to true and if only one dialect is configured and either outputFileNamePrefix or outputFileNameSuffix are set the dialect name will be omitted from the name of the DDL file.
  • Type: boolean
  • Required: No

<outputDirectory>

Location of the output file.
  • Type: java.io.File
  • Required: Yes
  • User Property: outputDir
  • Default: ${project.build.directory}/generated-resources/sql/ddl/auto

<outputFileNamePrefix>

If set each name of an output file will be prefixed with the value of this parameter.
  • Type: java.lang.String
  • Required: No

<outputFileNameSuffix>

If set the value of this parameter will be appended to the name of each output file.
  • Type: java.lang.String
  • Required: No

<packages>

Packages containing the entity files for which the SQL DDL scripts shall be generated.
  • Type: java.lang.String[]
  • Required: Yes

<persistencePropertiesToUse>

(no description)
  • Type: java.lang.String[]
  • Required: No

<persistenceXml>

The persistence.xml file to use to read properties etc. Default value is src/main/resources/META-INF/persistence.xml. If the file is not present it is ignored. If the file is present all properties set using a <property> element are set on the Hibernate configuration.
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/src/main/resources/META-INF/persistence.xml