Go to file
Yoann Rodière dc72e0f817
Mention Maven Compiler Plugin 3.12 in migration guide
2023-12-19 11:46:20 +01:00
.github Fix branch configuration for GitHub Actions workflow 2023-10-11 19:04:20 +02:00
.release HHH-17239 Automate maintenance releases 2023-10-05 22:26:48 +02:00
checkerstubs HHH-16515 - Get rid of nullness suppression in jpamodelgen TypeUtils 2023-09-20 09:14:41 +02:00
ci Add build option for configuring maven central mirror 2023-10-11 15:38:56 +02:00
databases HHH-17286 Upgrade integration tests to use Oracle JDBC driver version 23.3.0.23.09 2023-10-04 12:20:42 +02:00
design Add a class diagram for org.hibernate.spi to the design documentation 2023-04-26 00:41:22 +02:00
documentation HHH-17367 - Add links to the tutorial's example source code 2023-11-07 16:28:21 +01:00
drivers HHH-16511 - Ability to drop-in extra JDBC drivers 2023-04-25 04:59:25 -05:00
edb HHH-17087 Update container images to the latest version 2023-09-04 17:55:07 +02:00
etc HHH-16073 Remove deprecated cfg property 'hibernate.bytecode.use_reflection_optimizer' 2023-08-22 11:06:28 +02:00
gradle Post-steps for release : `6.3.2.Final` 2023-11-23 14:51:56 +00:00
hibernate-agroal HHH-16260 - JdbcParameterRenderer not called with dynamic filters 2023-03-09 19:51:33 -06:00
hibernate-c3p0 Use ojdbc6 for Oracle 11 to make timeout tests work 2023-10-02 15:19:12 +02:00
hibernate-community-dialects Fix HANA test failures 2023-10-13 14:25:33 +02:00
hibernate-core HHH-17328 Add discriminator to entity graph with inheritance subtypes 2023-11-16 15:18:14 +01:00
hibernate-envers HHH-17243 added Testcase for java.time.Duration 2023-09-29 10:34:34 +02:00
hibernate-graalvm HHH-16190 Update the GraalVM module to match the reflective needs of StandardStack 2023-02-16 20:54:11 +00:00
hibernate-hikaricp HHH-17082 - Improve documentation of configuration settings 2023-08-28 10:19:37 -05:00
hibernate-integrationtest-java-modules Use JUnit 5 for Java Modules integration tests 2023-08-07 17:15:59 +02:00
hibernate-jcache Make use of connection pooling in most tests 2023-09-06 14:57:05 +02:00
hibernate-micrometer HHH-16515 - Add o.h.exception to nullness checking 2023-07-17 21:56:22 +02:00
hibernate-platform HHH-16915 Add community dialects to the platform 2023-07-24 14:45:57 +02:00
hibernate-proxool HHH-17082 - Improve documentation of configuration settings 2023-08-28 10:19:37 -05:00
hibernate-spatial HHH-16876 Update Oracle testing to 23c 2023-10-05 23:59:30 +02:00
hibernate-testing HHH-16781 @JavaType annotation is ignored when basic type is already registered for the preferred JdbcType 2023-09-29 18:22:25 +02:00
hibernate-vibur More work on hibernate-platform and version catalog 2022-04-26 14:41:04 -05:00
javadoc HHH-17239 Automate maintenance releases 2023-10-05 22:26:48 +02:00
local-build-plugins HHH-17259 Add a "compatibility" section to the user guide 2023-09-26 14:46:16 +02:00
patched-libs/jaxb2-basics HHH-14837 - Move to Jakarta EE 2021-09-27 08:21:27 -05:00
release HHH-17239 Automate maintenance releases 2023-10-05 22:26:49 +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 HHH-16962 - General documentation improvements 2023-08-29 13:20:19 -05:00
tck Add TCK results for 6.0.0.Final 2022-04-01 12:23:26 +02:00
tooling HHH-17323 Add annotation processor for tests explicitly 2023-10-16 12:52:33 +02:00
.gitignore more consistent formatting for error messages 2022-10-28 03:19:05 +02:00
CONTRIBUTING.md HHH-14641 replace 'http://' reference with 'https://' 2021-06-04 12:09:45 +02:00
Jenkinsfile Add build option for configuring maven central mirror 2023-10-11 15:38:56 +02:00
README.adoc HHH-16876 Update Oracle testing to 23c 2023-10-05 23:59:30 +02:00
branching.adoc branching guide 2023-06-13 07:55:38 -05:00
build.gradle Update checker and adapt memory configuration 2023-10-13 16:49:43 +02:00
changelog.txt Pre-steps for release : `6.3.2.Final` 2023-11-23 14:50:19 +00:00
dco.txt CONTRIBUTING.md changes to add Legal section + adding dco.txt 2017-08-08 09:27:33 -05:00
dialects.adoc HHH-14663 : Add testing for s390x 2021-10-19 11:07:39 +02:00
docker_db.sh HHH-17315 Reduce Oracle database user privileges to avoid cross schemas clashes 2023-10-13 14:24:57 +02:00
gradle.properties Update checker and adapt memory configuration 2023-10-13 16:49:43 +02:00
gradlew HHH-17296 Gradle 8.4 upgrade 2023-10-06 11:30:41 +02:00
gradlew.bat HHH-17015 - Upgrade to Gradle 8 2023-08-02 08:20:40 -05: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 Mention Maven Compiler Plugin 3.12 in migration guide 2023-12-19 11:46:20 +01:00
nightly.Jenkinsfile HHH-17297 Adapt limited support testing for 6.2 2023-10-06 15:01:22 +02:00
settings.gradle Bump com.gradle.common-custom-user-data-gradle-plugin 2023-11-06 16:14:24 +01:00
test-case-guide.adoc Document JUnit 5 extensions 2023-02-15 11:56:06 -06:00
utilities.gradle HHH-12188 - Add Java 9 automatic module name hinting 2017-12-28 10:13:55 -06:00

README.adoc

Hibernate ORM is a powerful object/relational mapping solution for Java, and makes it easy to develop persistence logic for applications, libraries, and frameworks.

Hibernate implements JPA, the standard API for object/relational persistence in Java, but also offers an extensive set of features and APIs which go beyond the specification.

See https://hibernate.org/orm/[Hibernate.org] for more information.

image:https://ci.hibernate.org/job/hibernate-orm-pipeline/job/main/badge/icon[Build Status,link=https://ci.hibernate.org/job/hibernate-orm-pipeline/job/main/]
image:https://img.shields.io/badge/Revved%20up%20by-Gradle%20Enterprise-06A0CE?logo=Gradle&labelColor=02303A[link=https://ge.hibernate.org/scans]

== Continuous Integration

Hibernate uses both https://jenkins-ci.org[Jenkins] and https://github.com/features/actions[GitHub Actions]
for its CI needs. See

* https://ci.hibernate.org/view/ORM/[Jenkins Jobs]
* https://github.com/hibernate/hibernate-orm/actions[GitHub Actions Jobs]

== Building from sources

The build requires at least Java 11 and at most Java 17.

Hibernate uses https://gradle.org[Gradle] as its build tool. See the _Gradle Primer_ section below if you are new to
Gradle.

Contributors should read the link:CONTRIBUTING.md[Contributing Guide].

See the guides for setting up https://hibernate.org/community/contribute/intellij-idea/[IntelliJ] or
https://hibernate.org/community/contribute/eclipse-ide/[Eclipse] as your development environment.

== Gradle Primer

The Gradle build tool has amazing documentation.  2 in particular that are indispensable:

* https://docs.gradle.org/current/userguide/userguide_single.html[Gradle User Guide] is a typical user guide in that
it follows a topical approach to describing all of the capabilities of Gradle.
* https://docs.gradle.org/current/dsl/index.html[Gradle DSL Guide] is unique and excellent in quickly
getting up to speed on certain aspects of Gradle.

We will cover the basics developers and contributors new to Gradle need to know to get productive quickly.

NOTE: The project defines a https://docs.gradle.org/current/userguide/gradle_wrapper.html[Gradle Wrapper].
The rest of the section will assume execution through the wrapper.

=== 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:

. `cd` into that module directory and execute the task
. 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`

=== Common tasks

The common tasks you might use in building Hibernate include:

* _build_ - Assembles (jars) and tests this project
* _compile_ - 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
* _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.
* _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 later…

=== 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
----

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"
----

The following table illustrates a list of commands for various databases that can be tested locally.

|===
|Database |`docker_db.sh` |Gradle command

|H2
|-
|`./gradlew test -Pdb=h2`

|HSQLDB
|-
|`./gradlew test -Pdb=hsqldb`

|Apache Derby
|-
|`./gradlew test -Pdb=derby`

|MySQL
|`./docker_db.sh mysql`
|`./gradlew test -Pdb=mysql_ci`

|MariaDB
|`./docker_db.sh mariadb`
|`./gradlew test -Pdb=mariadb_ci`

|PostgreSQL
|`./docker_db.sh postgresql`
|`./gradlew test -Pdb=pgsql_ci`

|EnterpriseDB
|`./docker_db.sh edb`
|`./gradlew test -Pdb=edb_ci`

|Oracle XE
|`./docker_db.sh oracle`
|`./gradlew test -Pdb=oracle_free_ci`

|DB2
|`./docker_db.sh db2`
|`./gradlew test -Pdb=db2_ci`

|SQL Server
|`./docker_db.sh mssql`
|`./gradlew test -Pdb=mssql_ci`

|Sybase ASE (jTDS)
|`./docker_db.sh sybase`
|`./gradlew test -Pdb=sybase_ci`

|Sybase ASE (jConnect)
|`./docker_db.sh sybase`
|`./gradlew test -Pdb=sybase_jconn_ci`

|SAP HANA
|`./docker_db.sh hana`
|`./gradlew test -Pdb=hana_ci`

|CockroachDB
|`./docker_db.sh cockroachdb`
|`./gradlew test -Pdb=cockroachdb`

|TiDB
|`./docker_db.sh tidb`
|`./gradlew test -Pdb=tidb`
|===

To stop a container started by `docker`, use the command

[source]
----
docker stop $container_name
----

NOTE:: Substitute `podman` command for `docker` if using `podman`

E.g., to stop the mariadb container

[source]
----
docker stop mariadb
----