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

Since Release 0.3.3

• Java 9 support.
• Required Gradle 4.2.1 or above. (for support Java 9)

Since Release 0.3

• Required Gradle 4.0 or above.
• Required JDK 8 or above.
• No more output.resourcesDir = output.classesDir needed.
• No more buildscript dependencies needed.
• Dropped support DataNucleus, it was my mistake.

Reworking on 0.3

• Minimized spring dependency, only include spring-orm, spring-context, spring-aspects and its dependencies. (based on spring 5.0)
• Direct including any JPA implementation is removed, remains JUST API.
• Will improve test with each major release version of each JPA providers.
• Re-implemented with Kotlin, on my self-training.

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

EclipseLink

• EclipseLink 2.5 on Java 9 without persistence.xml will not work.
• 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

Hibernate with Spring ORM

• vendor should be hibernate+spring. (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.

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.

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

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

You can override using hibernate.dialect property.

• CUBRID
  • org.hibernate.dialect.CUBRIDDialect = all version
• HSQL Database Engine
  • org.hibernate.dialect.HSQLDialect = all version
• H2
  • org.hibernate.dialect.H2Dialect = all version
• MySQL
  • org.hibernate.dialect.MySQL5Dialect = 5.x
  • org.hibernate.dialect.MySQLDialect = 4.x or below
  • org.hibernate.dialect.MySQLMyISAMDialect
  • org.hibernate.dialect.MySQLInnoDBDialect
  • org.hibernate.dialect.MySQL5InnoDBDialect
  • org.hibernate.dialect.MySQL57InnoDBDialect
• PostgreSQL
  • org.hibernate.dialect.PostgreSQL94Dialect = 9.4 or above
  • org.hibernate.dialect.PostgreSQL92Dialect = 9.2 or above
  • org.hibernate.dialect.PostgreSQL9Dialect = 9.x
  • org.hibernate.dialect.PostgreSQL82Dialect = 8.2 or above
  • org.hibernate.dialect.PostgreSQL81Dialect = 8.1 or below
• Apache Derby
  • org.hibernate.dialect.DerbyTenSevenDialect = 10.7 or above
  • org.hibernate.dialect.DerbyTenSixDialect = 10.6
  • org.hibernate.dialect.DerbyTenFiveDialect = 10.5
  • org.hibernate.dialect.DerbyDialect = 10.4 or below
• ingres
  • org.hibernate.dialect.Ingres10Dialect = 10.x
  • org.hibernate.dialect.Ingres9Dialect = 9.2 or above
  • org.hibernate.dialect.IngresDialect = 9.1 or below
• Microsoft SQL Server
  • org.hibernate.dialect.SQLServer2012Dialect = 11.x
  • org.hibernate.dialect.SQLServer2008Dialect = 10.x
  • org.hibernate.dialect.SQLServer2005Dialect = 9.x
  • org.hibernate.dialect.SQLServerDialect = 8.x or below
• Sybase SQL Server
  • org.hibernate.dialect.SybaseASE15Dialect = all version
  • org.hibernate.dialect.SybaseASE17Dialect
• Adaptive Server Enterprise = Sybase
• Adaptive Server Anywhere
  • org.hibernate.dialect.SybaseAnywhereDialect = all version
• Informix Dynamic Server
  • org.hibernate.dialect.InformixDialect = all version
• DB2 UDB for AS/390
  • org.hibernate.dialect.DB2390Dialect
• DB2 UDB for AS/400
  • org.hibernate.dialect.DB2400Dialect = all version
• start with DB2/
  • org.hibernate.dialect.DB2Dialect = all version
• Oracle
  • org.hibernate.dialect.Oracle12cDialect = 12.x
  • org.hibernate.dialect.Oracle10gDialect = 11.x, 10.x
  • org.hibernate.dialect.Oracle9iDialect = 9.x
  • org.hibernate.dialect.Oracle8iDialect = 8.x or below
• Firebird
  • org.hibernate.dialect.FirebirdDialect = all version

License

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