Go to file
Yoann Rodière 07eca3883d HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
.github Skip certain LockTests for Oracle on GH Actions which don't work there 2021-04-06 16:12:19 +02:00
buildSrc HHH-14111 Ensure Groovy compilation tasks target the same JDK version as the rest of the project 2020-07-20 10:25:15 +02:00
ci Re-include the temporary jakarta testing modules 2021-05-06 06:37:41 +02:00
databases HHH-14494 Upgrade the PostgreSQL JDBC driver used for testing to v. 42.2.19 2021-03-12 12:54:30 +01:00
design Design docs - mapping model 2020-10-22 14:56:24 -05:00
documentation HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
etc HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
gradle HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-agroal HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-c3p0 HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-core HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-core-jakarta Make use of narayana Jakarta artifacts 2021-05-07 15:29:11 +02:00
hibernate-ehcache HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-entitymanager HHH-14563 Remove the DOM4J dependency from hibernate-core 2021-04-19 15:39:35 +02:00
hibernate-envers HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-envers-jakarta Make use of narayana Jakarta artifacts 2021-05-07 15:29:11 +02:00
hibernate-graalvm Fix issue with generated pom missing project description 2020-04-06 18:21:11 +01:00
hibernate-hikaricp HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-infinispan HHH-14513 Move publishing release artifacts from BinTray 2021-04-29 20:59:18 +02:00
hibernate-integrationtest-java-modules HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-java8 Fix issue with generated pom missing project description 2020-04-06 18:21:11 +01:00
hibernate-jcache HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-micrometer HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-osgi HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-proxool HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-spatial HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-testing HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-testing-jakarta HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
hibernate-transaction-client Fix publishing related issues in jakarta artifacts 2021-05-06 07:16:32 +02:00
hibernate-vibur HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
release HHH-14513 Move publishing release artifacts from BinTray 2021-04-29 20:59:18 +02:00
rules HHH-13946 Create Jakarta artifacts for hibernate-core, hibernate-envers, hibernate-jpamodelgen and hibernate-testing 2021-04-30 11:41:05 +02:00
shared/config/checkstyle HHH-14509 : Git master -> main branch renaming 2021-03-19 10:59:03 -05:00
tooling HHH-14635 Upgrade to log4j 2 2021-05-26 09:05:56 +02:00
.gitignore HHH-14324 Add .gradletasknamecache to .gitignore 2020-11-16 09:17:43 +00:00
CONTRIBUTING.md HHH-14509 : Git master -> main branch renaming 2021-03-19 10:59:03 -05:00
README.md Skip certain LockTests for Oracle on GH Actions which don't work there 2021-04-06 16:12:19 +02:00
build.gradle HHH-13946 Create Jakarta artifacts for hibernate-core, hibernate-envers, hibernate-jpamodelgen and hibernate-testing 2021-04-30 11:41:05 +02:00
changelog.txt 5.5.0.CR1 2021-05-24 11:24:50 +00:00
dco.txt CONTRIBUTING.md changes to add Legal section + adding dco.txt 2017-08-08 09:27:33 -05:00
docker_db.sh Skip certain LockTests for Oracle on GH Actions which don't work there 2021-04-06 16:12:19 +02:00
gradle.properties Only apply --add-opens to compiler JVM options when using JDK9+ 2021-05-07 11:00:43 +02:00
gradlew HHH-14315 Upgrade to Gradle 6.7 2020-11-10 11:02:08 +00:00
gradlew.bat HHH-14315 Upgrade to Gradle 6.7 2020-11-10 11:02:08 +00:00
hibernate_logo.gif SVN layout migration for core/trunk 2007-06-29 19:24:12 +00:00
lgpl.txt HHH-10961 Update address of Free Software Foundation 2018-02-14 11:25:26 +00:00
migration-guide.adoc HHH-13704 Make javassist a compile time dependency again 2019-12-13 11:29:40 +00:00
settings.gradle Make use of narayana Jakarta artifacts 2021-05-07 15:29:11 +02:00
test-case-guide.adoc HHH-14509 : Git master -> main branch renaming 2021-03-19 10:59:03 -05:00
utilities.gradle HHH-12188 - Add Java 9 automatic module name hinting 2017-12-28 10:13:55 -06:00

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 Language grade: Java

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 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 feature 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, to run the tests for the hibernate-core module from the root directory you could say gradle hibernate-core:test
  • 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 several 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 be sure to add these drivers to your local Maven repo cache (~/.m2/repository) or (better) add it to a personal Maven repo server

Running database-specific tests from the IDE using "profiles"

You can run any test on any particular database that is configured in a databases.gradle profile.

All you have to do is run the following command:

gradlew setDataBase -Pdb=pgsql

or you can use the shortcut version:

gradlew sDB -Pdb=pgsql

You can do this from the module which you are interested in testing or from the hibernate-orm root folder.

Afterward, just pick any test from the IDE and run it as usual. Hibernate will pick the database configuration from the hibernate.properties file that was set up by the setDataBase Gradle task.

Starting test databases locally as docker containers

You don't have to install all databases locally to be able to test against them in case you have docker available. The script docker_db.sh allows you to start a pre-configured database which can be used for testing.

All you have to do is run the following command:

./docker_db.sh postgresql_9_5

omitting the argument will print a list of possible options.

When the database is properly started, you can run tests with special profiles that are suffixed with _ci e.g. pgsql_ci for PostgreSQL. By using the system property dbHost you can configure the IP address of your docker host.

The command for running tests could look like the following:

gradlew test -Pdb=pgsql_ci "-DdbHost=192.168.99.100"