Go to file
Steve Ebersole ff2cd561f5 HHH-15344 - Ability to apply testing annotations at method-level
- `@SessionFactory`
2022-06-16 21:15:18 +01:00
.github Remove open-pull-requests-limit setting 2022-05-06 12:16:33 -05:00
ci Prepare Jenkinsfiles for TCK runs to be multi-branch friendly 2022-05-12 12:44:38 +02:00
databases Upgrading the DB2 JDBC driver JCC to 11.5.7.0 2021-12-22 11:28:57 +00:00
design - Drop building of bundles for SourceForge 2022-03-31 11:58:26 -05:00
documentation documentation for hibernate.enable_lazy_load_no_trans 2022-06-10 17:00:29 +02:00
etc remove hibernate.jdbc.use_streams_for_binary config property 2022-01-21 16:52:09 +01:00
gradle Allow passing test launcher args through project properties 2022-06-09 17:13:56 +02:00
hibernate-agroal More work on hibernate-platform and version catalog 2022-04-26 14:41:04 -05:00
hibernate-c3p0 More work on hibernate-platform and version catalog 2022-04-26 14:41:04 -05:00
hibernate-community-dialects Do some renaming for consistency and update documentation for new SQL types 2022-03-29 19:31:53 +02:00
hibernate-core HHH-15344 - Ability to apply testing annotations at method-level 2022-06-16 21:15: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-15226 - Publish a Gradle platform (Maven Bom++) for Hibernate ORM 2022-04-26 14:41:04 -05:00
hibernate-graalvm HHH-15226 - Publish a Gradle platform (Maven Bom++) for Hibernate ORM 2022-04-26 14:41:04 -05:00
hibernate-hikaricp More work on hibernate-platform and version catalog 2022-04-26 14:41:04 -05:00
hibernate-integrationtest-java-modules Get rid of MVCC JDBC connection parameter 2022-03-24 09:15:11 +01:00
hibernate-jcache HHH-15150 Add test for issue 2022-04-29 15:16:50 -05:00
hibernate-micrometer More work on hibernate-platform and version catalog 2022-04-26 14:41:04 -05:00
hibernate-platform More work on hibernate-platform and version catalog 2022-04-26 14:41:04 -05:00
hibernate-proxool More work on hibernate-platform and version catalog 2022-04-26 14:41:04 -05:00
hibernate-spatial HHH-15200 Add support for the SQLXML type 2022-05-05 09:07:37 +02:00
hibernate-testing HHH-15344 - Ability to apply testing annotations at method-level 2022-06-16 21:15:18 +01:00
hibernate-vibur More work on hibernate-platform and version catalog 2022-04-26 14:41:04 -05:00
local-build-plugins Copy only the content of the documentation staging directory 2022-05-19 12:15:02 +02:00
patched-libs/jaxb2-basics HHH-14837 - Move to Jakarta EE 2021-09-27 08:21:27 -05:00
release release doc 2022-06-07 05:59:56 -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-15314 - Hibernate Gradle plugin is not working for Kotlin projects 2022-06-08 17:32:52 -05:00
.gitignore HHH-14324 Add .gradletasknamecache to .gitignore 2020-11-16 09:17:43 +00:00
CONTRIBUTING.md HHH-14641 replace 'http://' reference with 'https://' 2021-06-04 12:09:45 +02:00
Jenkinsfile Add missing space between Gradle arguments when passing --enable-preview to the test launcher 2022-06-09 17:24:52 +02:00
README.adoc Switch to new Oracle image and try to improve podman experience 2022-04-07 12:34:00 +02:00
build.gradle HHH-15236 - Fix signing of published artifacts 2022-04-29 08:18:18 -05:00
changelog.txt Pre-steps for release : `6.1.0.Final` 2022-06-07 09:08:23 +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-15245 update the CockroachDB docker config 2022-05-04 16:28:05 +02:00
gradle.properties Gradle task cache 2021-07-26 13:51:38 -05: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
lgtm.yml HHH-14986 - drop build_command 2021-12-18 04:36:25 -06:00
migration-guide.adoc HHH-15288 Switch to SMALLINT as recommended type for enums 2022-05-30 19:52:39 +02:00
settings.gradle Bump com.gradle.common-custom-user-data-gradle-plugin 2022-06-14 11:42:03 +01:00
test-case-guide.adoc Merge remote-tracking branch 'upstream/main' into wip/6.0_merge 2021-11-15 13:52:08 +01: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-main-h2-main/badge/icon[Build Status,link=https://ci.hibernate.org/job/hibernate-orm-main-h2-main/]
image:https://img.shields.io/lgtm/grade/java/g/hibernate/hibernate-orm.svg?logo=lgtm&logoWidth=18[Language grade: Java,link=https://lgtm.com/projects/g/hibernate/hibernate-orm/context:java]

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

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 5.7
|`./docker_db.sh mysql_5_7`
|`./gradlew test -Pdb=mysql_ci`

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

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

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

|PostgreSQL 13
|`./docker_db.sh postgresql_13`
|`./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`

|Oracle 11g
|`./docker_db.sh oracle_11`
|`./gradlew test -Pdb=oracle_ci`

|Oracle XE 18
|`./docker_db.sh oracle_18`
|`./gradlew test -Pdb=oracle_ci`

|Oracle XE 21
|`./docker_db.sh oracle_21`
|`./gradlew test -Pdb=oracle_ci`

|Oracle EE
|`./docker_db.sh oracle_ee`
|`./gradlew test -Pdb=oracle_docker`

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