Go to file
Davide D'Alto e6c8fbc7af HHH-16443 Convert SqlStatementLogger into a Service
This way is possible to get the logger without having
to initialize the JdbcServices service.

Without this change, in Hibernate Reactive, we have a cyclic
dependency during the initialization of the services between
JdbcEnvironment and JdbcServices.
2023-04-08 10:48:18 +01:00
.github Bump actions/checkout from 2 to 3 2023-02-27 16:31:13 +01:00
checkerstubs HHH-16389 Introduce checkerframework for nullness marking/checking and null check the JPA metamodel generator 2023-04-05 19:14:37 +02:00
ci HHH-16324 Update JPA TCK to 3.1.2 2023-03-17 10:11:04 +01:00
databases HHH-15961 Speed-up Oracle CI build 2023-01-03 10:26:46 +01:00
design Contribute a query class diagram 2023-04-04 00:09:41 +02:00
documentation PublishMigrationGuide task 2023-04-01 09:37:40 -05:00
edb HHH-15626 Move old databases to nightly pipeline and add some SQL Server 2022 features 2022-11-18 11:06:39 +01:00
etc HHH-15692 Remove references to hibernate.query.factory_class config property 2022-11-17 13:39:56 +00:00
gradle HHH-16389 Introduce checkerframework for nullness marking/checking and null check the JPA metamodel generator 2023-04-05 19:14:37 +02:00
hibernate-agroal HHH-16260 - JdbcParameterRenderer not called with dynamic filters 2023-03-09 19:51:33 -06:00
hibernate-c3p0 Fix possible Mockito concurrency issue 2023-02-06 12:22:14 +01:00
hibernate-community-dialects Fix issues with nightly tests 2023-03-30 15:43:51 +02:00
hibernate-core HHH-16443 Convert SqlStatementLogger into a Service 2023-04-08 10:48:18 +01:00
hibernate-ehcache/src/test/resources Merge remote-tracking branch 'upstream/main' into wip/6.0_merge_7 2021-05-31 14:55:18 +02:00
hibernate-envers HHH-16097 Move all tests from documentation into hibernate-core 2023-03-24 07:43:13 -05: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 Replace mockito for some tests with custom spies 2023-02-13 18:40:46 +01:00
hibernate-integrationtest-java-modules HHH-16060 Upgrade Narayana used for integration testing to version 6.0.0.CR1 2023-01-19 14:59:20 +00:00
hibernate-jcache HHH-16097 Move all tests from documentation into hibernate-core 2023-03-24 07:43:13 -05:00
hibernate-micrometer HHH-15563 BeanValidation integration should prioritize jakarta.persistence.validation over javax.persistence.validation 2022-10-01 18:31:57 +01:00
hibernate-platform HHH-15381 Try to fix gradle plugin publishing and platform publishing 2022-09-02 16:44:51 +02:00
hibernate-proxool HHH-15760 mass replace self-closing tags in javadoc 2022-11-26 09:49:56 +01:00
hibernate-spatial HHH-16097 Move all tests from documentation into hibernate-core 2023-03-24 07:43:13 -05:00
hibernate-testing HHH-16430 Avoid AnsiSqlKeywords to retain all keywords as static constants 2023-04-04 12:51:17 +02:00
hibernate-vibur More work on hibernate-platform and version catalog 2022-04-26 14:41:04 -05:00
local-build-plugins PublishMigrationGuide task 2023-04-01 09:37:40 -05:00
patched-libs/jaxb2-basics HHH-14837 - Move to Jakarta EE 2021-09-27 08:21:27 -05:00
release PublishMigrationGuide task 2023-04-01 09:37:40 -05: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
tck Add TCK results for 6.0.0.Final 2022-04-01 12:23:26 +02:00
tooling HHH-16389 Introduce checkerframework for nullness marking/checking and null check the JPA metamodel generator 2023-04-05 19:14:37 +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 Stop testing against JDK 18 2023-01-18 12:25:14 +01:00
README.adoc Switch from LGTM to CodeQL 2022-12-16 12:52:58 +01:00
build.gradle HHH-16389 Introduce checkerframework for nullness marking/checking and null check the JPA metamodel generator 2023-04-05 19:14:37 +02:00
changelog.txt Pre-steps for release : `6.2.0.CR1` 2022-12-22 23:35:20 +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-16131 - Added workaround and test for date calculcation errors on Oracle 2023-02-08 17:52:24 +01:00
gradle.properties Increase metaspace size for test JVM to avoid OOM 2022-11-14 10:15:08 +01:00
gradlew Upgrade to Gradle 7.3.3 2022-01-11 15:47:48 -06:00
gradlew.bat HHH-14709 Upgrade to Gradle 6.7.1 2021-07-09 12:42:08 +02: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-16388 - Configuration setting for wrapper Byte[]/Character[] treatment 2023-03-30 18:07:45 +02:00
nightly.Jenkinsfile Update CockroachDB testing to use version 22.2.2 2023-01-10 18:46:57 +01:00
settings.gradle HHH-16403 Upgrade to assertj 3.22.0 2023-04-05 15:22:42 +02: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 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 https://hibernate.org/orm/[Hibernate.org] for additional 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 JDK.

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_ci`

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

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

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

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

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