Go to file
Steve Ebersole b1e2412bf2 PublishMigrationGuide task 2023-04-01 09:34:28 -05:00
.github Update 'com.gradle.enterprise' to '3.12.3', 'com.gradle.common-custom-user-data-gradle-plugin' to '1.8.2', GitHub actions workflow steps setup-java, cache and upload-artifact to v3, and run dependabot on github actions versions 2023-02-03 18:02:01 +01:00
ci HHH-15765 Get rid of the credentials plugin 2022-11-28 08:29:03 +01:00
databases HHH-15448 Run tests on MSSQL Server using trustServerCertificate=true 2022-08-16 09:35:17 +01:00
design - Drop building of bundles for SourceForge 2022-03-31 11:58:26 -05:00
documentation PublishMigrationGuide task 2023-04-01 09:34:28 -05:00
edb HHH-15615 Add EDB PostgreSQL Advanced to test matrix and fix issues 2022-10-21 14:38:13 +02:00
etc remove hibernate.jdbc.use_streams_for_binary config property 2022-01-21 16:52:09 +01:00
gradle Post-steps for release : `6.1.7.Final` 2023-02-07 11:31:00 +00:00
hibernate-agroal More work on hibernate-platform and version catalog 2022-04-26 14:41:04 -05:00
hibernate-c3p0 HHH-15406 Tests annotated with org.hibernate.testing.RequiresDialect having as value a deprecated dialect are not executed 2022-07-21 22:00:14 +02:00
hibernate-community-dialects HHH-15461 Replace uses of method references for SqlAppender with proper implementation 2022-08-25 09:43:48 +02:00
hibernate-core HHH-16177 Test catalog/schema creation/dropping in DefaultCatalogAndSchemaTest 2023-02-21 09:24:41 +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-15790 Refactor casting strategies for HibernateProxy across the codebase 2022-12-01 21:32:13 +00: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 HHH-15381 Try to fix gradle plugin publishing and platform publishing 2022-09-02 16:44:51 +02:00
hibernate-proxool More work on hibernate-platform and version catalog 2022-04-26 14:41:04 -05:00
hibernate-spatial HHH-15528 Add Cockroach to Jenkins nightly test matrix and fix issues 2022-10-21 12:38:31 +02:00
hibernate-testing HHH-16043 Add test for issue 2023-01-25 17:50:33 +01: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:34:28 -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:34:28 -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-15707 - Fix Gradle plugin with Kotlin 1.7.0 or higher 2023-02-06 18:01:36 +01:00
.gitignore more consistent formatting for error messages 2022-10-28 11:19:45 +02:00
CONTRIBUTING.md HHH-14641 replace 'http://' reference with 'https://' 2021-06-04 12:09:45 +02:00
Jenkinsfile Switch to HANA cloud instances 2022-10-24 20:44:13 +02:00
README.adoc Switch from LGTM to CodeQL 2022-12-16 13:37:47 +01:00
build.gradle Fix build error 2022-11-28 09:09:19 +01:00
changelog.txt Pre-steps for release : `6.1.7.Final` 2023-02-07 11:26:48 +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 Revert "Disable dynamic sequence caching for Oracle CI" 2022-11-26 09:38:16 +01: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
migration-guide.adoc HHH-16085 Document how to revert to pre-6.1 behavior for array mapping 2023-01-25 17:57:52 +01:00
nightly.Jenkinsfile Switch to HANA cloud instances 2022-10-24 20:44:13 +02:00
settings.gradle Update 'com.gradle.enterprise' to '3.12.3', 'com.gradle.common-custom-user-data-gradle-plugin' to '1.8.2', GitHub actions workflow steps setup-java, cache and upload-artifact to v3, and run dependabot on github actions versions 2023-02-03 18:02:01 +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-pipeline/job/6.1/badge/icon[Build Status,link=https://ci.hibernate.org/job/hibernate-orm-pipeline/job/6.1/]

== 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 5.7
|`./docker_db.sh mysql`
|`./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`
|`./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`
|===