jpa-schema-gradle-plugin

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 😱) JPA will generate weird scripts, so you SHOULD modify them properly.

Version History

See Releases for more information...

0.4.x

Counterpart for Gradle 6.x

• Required JDK 8 or above.
• Required Gradle 6.0 or above. (for support Java 13 or above)

0.3.x

Counterpart Gradle 4.10 to 5.x

• Required JDK 8 or above.
• Required Gradle 4.10 or above. (for support spring-boot plugin version 2.0+)

How-to Use

see Gradle Plugins Registry.

Groovy

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

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

Kotlin

plugins {
  id("io.github.divinespear.jpa-schema-generate") version("0.4.0")
}

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

To generate schema, run

gradle generateSchema

or

./gradlew generateSchema

see also functional test cases as examples.

without persistence.xml

You MUST specify two options: vendor and packageToScan.

Groovy

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

Kotlin

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

Plugin only dependencies

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

Groovy

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

dependencies {
  // ...omitted...
  implementation '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 {
  // ...omitted...
  packageToScan = [
    // load java.time converter from spring-data-jpa
    'org.springframework.data.jpa.convert.threeten',
    'your.package.to.scan',
    // more...
  ]
}

Kotlin

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

dependencies {
  // ...omitted...
  implementation("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 {
  // ...omitted...
  packageToScan = setOf(
    // load java.time converter from spring-data-jpa
    "org.springframework.data.jpa.convert.threeten",
    "your.package.to.scan",
    // more...
  )
}

Provider-specific issues

EclipseLink

• EclipseLink 2.6 on Java 12 or higher will not work. embedded ASM library cannot read class files.
• EclipseLink's Oracle{8,9,10,11}Platform uses some type classes from Oracle's JDBC driver. you should have it in your dependency.

Hibernate

• After 5.2, just use hibernate-core instead hibernate-entitymanager, it is merged.

• Naming strategy property is

  • 4.x: hibernate.ejb.naming_strategy
  • 5.x: hibernate.physical_naming_strategy / hibernate.implicit_naming_strategy

• For select dialect without persistence.xml, do one of

  • set hibernate.dialect on properties
  • set databaseProductName, databaseMajorVersion, and/or databaseMinorVersion for determine dialect.

Hibernate with Spring ORM

• vendor should be hibernate+spring, others are same as hibernate without persistence.xml
• use io.spring.dependency-management for version management.
  • You can change hibernate version with hibernate.version property.

SchemaGenerationConfig

Here is full list of parameters of generateSchema.

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

How-to config library specific properties

It's just map, so you can config like this

Groovy

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

Kotlin

generateSchema {
  // global properties
  properties = mapOf(
    "hibernate.dialect" to "org.hibernate.dialect.MySQL5InnoDBDialect",
    // more...
  )
  // you can set target-specific too.
}

Database Product Names

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

for EclipseLink

databaseMajorVersion and databaseMinorVersion is not required.

• Oracle12 = Oracle 12c
• Oracle11 = Oracle 11g
• Oracle10 = Oracle 10g
• Oracle9 = Oracle 9i
• Oracle = Oracle with default compatibility
• Microsoft SQL Server
• DB2
• MySQL
• PostgreSQL
• SQL Anywhere
• Sybase SQL Server
• Adaptive Server Enterprise = Sybase
• Pointbase
• Informix Dynamic Server
• Firebird
• ingres
• Apache Derby
• H2
• HSQL Database Engine

for Hibernate

• All dialect list of 5.4.12
• Preregistered dialects of 5.4.12

For other versions, select tag to your version.

License

Source Copyright © 2013-2021 Sinyoung "Divinespear" Kang (divinespear at gmail dot com). Distributed under the Apache License, Version 2.0.