Java Other
Permalink
Failed to load latest commit information.
buildSrc Wildfly unpacked forlder used for tests should not be included into d… Mar 17, 2017
databases HHH-11598 - change pgsql driver version to 9.4.1208 Mar 29, 2017
documentation HHH-12082 - Fix some errors and formatting issues in the User Guide Nov 7, 2017
etc Improved Hibernate support for SAP HANA Sep 21, 2017
gradle/wrapper HHH-11507 - Upgrade to Gradle 4.2 Sep 21, 2017
hibernate-c3p0 HHH-11646 revert errant after -> afterQuery search and replace May 3, 2017
hibernate-core HHH-9158 - cascade-persist in orm.xml does not apply to annotation-ba… Nov 16, 2017
hibernate-ehcache HHH-11646 revert errant after -> afterQuery search and replace May 3, 2017
hibernate-entitymanager HHH-11152: Added BytecodeProvider based on Byte Buddy Nov 16, 2016
hibernate-envers HHH-12073 - Change BaseUnitTestCase Logger to protected Nov 1, 2017
hibernate-hikaricp HHH-12001 - Allow ORM to be built with Java 9 Sep 21, 2017
hibernate-infinispan HHH-12073 - Change BaseUnitTestCase Logger to protected Nov 1, 2017
hibernate-java8 HHH-10883 - Fix Restore the Maven artifact hibernate-java8 as an empt… Jun 28, 2016
hibernate-jcache HHH-11536 - Fix unit tests failing on Oracle Mar 2, 2017
hibernate-orm-modules HHH-12055 Revert to using the Javassist version included in WildFly 11 Oct 24, 2017
hibernate-osgi HHH-12001 - Allow ORM to be built with Java 9 Sep 21, 2017
hibernate-proxool HHH-12073 - Change BaseUnitTestCase Logger to protected Nov 1, 2017
hibernate-spatial HHH-11969 - Update postgresql driver to latest version (42.1.4) Oct 18, 2017
hibernate-testing HHH-12085 - @NaturalId not working on inherited field Nov 10, 2017
release HHH-10629 - Spatial not bundled in release bundles Aug 12, 2016
shared HHH-11235 - split checkstyles into fatal and non-fatal configs Nov 9, 2016
tooling HHH-11871 - Skip Metamodel attribute generation for non-Java Bean pro… Nov 6, 2017
.gitignore HHH-10689 - Fix tests failing when switching to Oracle May 17, 2016
CONTRIBUTING.md Update CONTRIBUTING.md Aug 9, 2017
README.md README updates and typos Nov 6, 2017
build.gradle Add gradle task to copy resources to out folder Nov 10, 2017
changelog.txt 5.2.12 Oct 19, 2017
databases.gradle Improved Hibernate support for SAP HANA Sep 21, 2017
dco.txt CONTRIBUTING.md changes to add Legal section + adding dco.txt Aug 8, 2017
gradlew HHH-11507 - Upgrade to Gradle 4.2 Sep 21, 2017
gradlew.bat HHH-11346 - Upgrade gradle to 3.2.1 Dec 20, 2016
hibernate_logo.gif SVN layout migration for core/trunk Jun 29, 2007
lgpl.txt SVN layout migration for core/trunk Jun 29, 2007
libraries.gradle HHH-12081 Update to JBoss Logger 3.3.1.Final and related tooling 2.1.… Nov 6, 2017
migration-guide.adoc HHH-11614 : Update migration guide with example for converting variab… Sep 11, 2017
settings.gradle HHH-10812 Adding module ZIP and integration test for using Hibernate … Jun 29, 2016
utilities.gradle HHH-9803 - Checkstyle fix ups - headers May 19, 2015

README.md

Hibernate ORM is a library providing Object/Relational Mapping (ORM) support to applications, libraries and frameworks.

It also provides an implementation of the JPA specification, which is the standard Java specification for ORM.

This is the repository of its source code: see Hibernate.org for additional information.

Build Status

Building from sources

The build requires a Java 8 JDK as JAVA_HOME.

You will need Git to obtain the source.

Hibernate uses Gradle as its build tool. See the Gradle Primer section below if you are new to Gradle.

Contributors should read the Contributing Guide.

See the guides for setting up IntelliJ or Eclipse as your development environment.

Check out the Getting Started section in CONTRIBUTING.md for getting started working on Hibernate source.

Continuous Integration

Hibernate makes use of Jenkins for its CI needs. The project is built continuous on each push to the upstream repository. Overall there are a few different jobs, all of which can be seen at http://ci.hibernate.org/view/ORM/

Gradle primer

This section describes some of the basics developers and contributors new to Gradle might need to know to get productive quickly. The Gradle documentation is very well done; 2 in particular that are indispensable:

  • Gradle User Guide is a typical user guide in that it follows a topical approach to describing all of the capabilities of Gradle.
  • Gradle DSL Guide is quite unique and excellent in quickly getting up to speed on certain aspects of Gradle.

Using the Gradle Wrapper

For contributors who do not otherwise use Gradle and do not want to install it, Gradle offers a very cool features called the wrapper. It lets you run Gradle builds without a previously installed Gradle distro in a zero-conf manner. Hibernate configures the Gradle wrapper for you. If you would rather use the wrapper and not install Gradle (or to make sure you use the version of Gradle intended for older builds) you would just use the command gradlew (or gradlew.bat) rather than gradle (or gradle.bat) in the following discussions. Note that gradlew is only available in the project's root dir, so depending on your working directory you may need to adjust the path to gradlew as well.

Examples use the gradle syntax, but just swap gradlew (properly relative) for gradle if you wish to use the wrapper.

Another reason to use gradlew is that it uses the exact version of Gradle that the build is defined to work with.

Executing Tasks

Gradle uses the concept of build tasks (equivalent to Ant targets or Maven phases/goals). You can get a list of available tasks via

gradle tasks

To execute a task across all modules, simply perform that task from the root directory. Gradle will visit each sub-project and execute that task if the sub-project defines it. To execute a task in a specific module you can either:

  1. cd into that module directory and execute the task
  2. name the "task path". For example, in order to run the tests for the hibernate-core module from the root directory you could say gradle hibernate-core:test

Common Java related tasks

  • build - Assembles (jars) and tests this project
  • buildDependents - Assembles and tests this project and all projects that depend on it. So think of running this in hibernate-core, Gradle would assemble and test hibernate-core as well as hibernate-envers (because envers depends on core)
  • classes - Compiles the main classes
  • testClasses - Compiles the test classes
  • compile (Hibernate addition) - Performs all compilation tasks including staging resources from both main and test
  • jar - Generates a jar archive with all the compiled classes
  • test - Runs the tests
  • publish - Think Maven deploy
  • publishToMavenLocal - Installs the project jar to your local maven cache (aka ~/.m2/repository). Note that Gradle never uses this, but it can be useful for testing your build with other local Maven-based builds.
  • eclipse - Generates an Eclipse project
  • idea - Generates an IntelliJ/IDEA project (although the preferred approach is to use IntelliJ's Gradle import).
  • clean - Cleans the build directory

Testing and databases

Testing against a specific database can be achieved in 2 different ways:

Using the "Matrix Testing Plugin" for Gradle.

Coming soon...

Using "profiles"

The Hibernate build defines a number of database testing "profiles" in databases.gradle. These profiles can be activated by name using the db build property which can be passed either as a JVM system prop (-D) or as a Gradle project property (-P). Examples below use the Gradle project property approach.

gradle clean build -Pdb=pgsql

To run a test from your IDE, you need to ensure the property expansions happen. Use the following command:

gradle clean compile -Pdb=pgsql

NOTE : If you are running tests against a JDBC driver that is not available via Maven central (generally due to license nonsense - Oracle, DB2, etc) be sure to add these drivers to your local Maven repo cache (~/.m2/repository) or (better) add it to a personal Maven repo server