View on GitHub

jpa-schema-gradle-plugin

Gradle plugin for generate database schema or DDL scripts from JPA entities

Download this project as a .zip file Download this project as a tar.gz file

jpa-schema-gradle-plugin

Version 0.3.5.1 Build Status

Gradle plugin for generate schema or DDL scripts from JPA entities using JPA 2.1 schema generator. for Maven, see Maven Plugin.

Currently support EclipseLink (Reference Implementation) and Hibernate.

Before Announce…

READ MY LIP; JPA DDL GENERATOR IS NOT SILVER BULLET

Sometimes (most times exactly :P) JPA will generate weird scripts so you SHOULD modify them properly.

Since Release 0.3.3

Since Release 0.3

Reworking on 0.3

If you have discussions, please make issue. discussions are always welcome.

How-to Use

see Gradle Plugins Registry.

plugins {
  id 'io.github.divinespear.jpa-schema-generate' version '0.3.5.1'
}

generateSchema {
  // default options
  // see SchemaGenerationConfig to all options
  ...
  // if you want multiple output
  targets {
    targetName {
      // same as default options
      ...
    }
  }
}

To generate schema, run

gradle generateSchema

or

./gradlew generateSchema

see also test cases Generate*Spec.groovy, as examples.

without persistence.xml

You MUST specify two options: vendor and packageToScan.

generateSchema {
  vendor = 'hibernate' // 'eclipselink', 'hibernate', or 'hibernate+spring'.
                       // you can use class name too. (like 'org.hibernate.jpa.HibernatePersistenceProvider')
  packageToScan = [ 'your.package.to.scan', ... ]
  ...
}

Plugin only dependencies

Since 0.3.4, you can add dependencies for plugin with configuration generateSchema.

// no need to add 'generateSchema' into configurations block.

dependencies {
  ...
  compile 'org.springframework.boot:spring-boot-starter-data-jpa'
  // only need to load java.time converter from spring-data-jpa on schema generation
  generateSchema 'org:threeten:threetenbp:1.3.6'
}

generateSchema {
  ...  
  packageToScan = [
    // load java.time converter from spring-data-jpa
    'org.springframework.data.jpa.convert.threeten',
    'your.package.to.scan',
    ...
  ]
  ...
}

Provider specific

Hibernate

Hibernate with Spring ORM

SchemaGenerationConfig

Here is full list of parameters of generateSchema.

name type description
skip boolean skip schema generation<p>default value is false.</p>
format boolean generate as formatted<p>default value is false.</p>
scanTestClasses boolean scan test classes<p>default value is false.</p>
persistenceXml string location of persistence.xml file<p>Note: Hibernate DOES NOT SUPPORT custom location. (SchemaExport support it, but JPA 2.1 schema generator does NOT.)</p><p>default value is META-INF/persistence.xml.</p>
persistenceUnitName string unit name of persistence.xml<p>default value is default.</p>
databaseAction string schema generation action for database<p>support value is one of <ul><li>none</li><li>create</li><li>drop</li><li>drop-and-create</li><li>create-or-extend-tables (only for EclipseLink with database target)</li></ul></p><p>default value is none.</p>
scriptAction string schema generation action for script<p>support value is one of <ul><li>none</li><li>create</li><li>drop</li><li>drop-and-create</li></ul></p><p>default value is none.</p>
outputDirectory file output directory for generated ddl scripts<p>REQUIRED for scriptAction is one of create, drop, or drop-and-create.</p><p>default value is ${project.buildDir}/generated-schema.</p>
createOutputFileName string generated create script name<p>REQUIRED for scriptAction is one of create, or drop-and-create.</p><p>default value is {targetName}-create.sql if targetName presented, otherwise create.sql.</p>
dropOutputFileName string generated drop script name<p>REQUIRED for scriptAction is one of drop, or drop-and-create.</p><p>default value is {targetName}-drop.sql if targetName presented, otherwise drop.sql.</p>
createSourceMode string specifies whether the creation of database artifacts is to occur on the basis of the object/relational mappingmetadata, DDL script, or a combination of the two.<p>support value is one of <ul><li>metadata</li><li>script</li><li>metadata-then-script</li><li>script-then-metadata</li></ul></p><p>default value is metadata.</p>
createSourceFile string create source file path.<p>REQUIRED for createSourceMode is one of script, metadata-then-script, orscript-then-metadata.</p>
dropSourceMode string specifies whether the dropping of database artifacts is to occur on the basis of the object/relational mappingmetadata, DDL script, or a combination of the two.<p>support value is one of <ul><li>metadata</li><li>script</li><li>metadata-then-script</li><li>script-then-metadata</li></ul></p><p>default value is metadata.</p>
dropSourceFile file drop source file path.<p>REQUIRED for dropSourceMode is one of script, metadata-then-script, orscript-then-metadata.</p>
jdbcDriver string jdbc driver class name<p>default is declared class name in persistence xml.</p><p>and Remember, No Russian you MUST configure jdbc driver to dependencies.</p>
jdbcUrl string jdbc connection url<p>default is declared connection url in persistence xml.</p>
jdbcUser string jdbc connection username<p>default is declared username in persistence xml.</p>
jdbcPassword string jdbc connection password<p>default is declared password in persistence xml.</p><p>If your account has no password (especially local file-base, like Apache Derby, H2, etc…), it can be omitted.</p>
databaseProductName string database product name for emulate database connection. this should useful for script-only action.<ul><li>specified if scripts are to be generated by the persistence provider and a connection to the target databaseis not supplied.</li><li>The value of this property should be the value returned for the target database by DatabaseMetaData#getDatabaseProductName()</li></ul>
databaseMajorVersion int database major version for emulate database connection. this should useful for script-only action.<ul><li>specified if sufficient database version information is not included from DatabaseMetaData#getDatabaseProductName()</li><li>The value of this property should be the value returned for the target database by DatabaseMetaData#getDatabaseMajorVersion()</li></ul>
databaseMinorVersion int database minor version for emulate database connection. this should useful for script-only action.<ul><li>specified if sufficient database version information is not included from DatabaseMetaData#getDatabaseProductName()</li><li>The value of this property should be the value returned for the target database by DatabaseMetaData#getDatabaseMinorVersion()</li></ul>
lineSeparator string line separator for generated schema file.<p>support value is one of CRLF (windows default), LF (*nix, max osx), and CR (classic mac), in case-insensitive.</p><p>default value is system property line.separator. if JVM cannot detect line.separator, then use LF by git core.autocrlf handling.</p>
properties java.util.Map JPA vendor specific properties.
vendor string JPA vendor name or class name of vendor’s PersistenceProvider implemention.<p>vendor name is one of <ul><li>eclipselink(or org.eclipse.persistence.jpa.PersistenceProvider)</li><li>hibernate (or org.hibernate.jpa.HibernatePersistenceProvider)</li><li>hibernate+spring (or org.springframework.orm.jpa.vendor.SpringHibernateJpaPersistenceProvider)</li></ul></p><p>REQUIRED for project without persistence.xml</p>
packageToScan java.util.List list of package name for scan entity classes<p>REQUIRED for project without persistence.xml</p>

How-to config properties

It’s just groovy map, so you can config like this:

generateSchema {
  ...
  // global properties
  properties = [
    'hibernate.dialect': 'org.hibernate.dialect.MySQL5InnoDBDialect',
    ...
  ]
  // you can set target-specific too.
  ...
}

Database Product Names

It’s about databaseProductName property. If not listed below, will work as basic standard SQL.

databaseMajorVersion and databaseMinorVersion is not required.

for Hibernate

Some products uses different dialect by databaseMajorVersion and/or databaseMinorVersion. (striked dialects are not resolved by default.)

You can override using hibernate.dialect property.

License

Source Copyright © 2013-2018 Sin Young “Divinespear” Kang (divinespear at gmail dot com). Distributed under the Apache License, Version 2.0.