Skip to content

connection pool migration #9361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 3, 2024
Merged

connection pool migration #9361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2bd500b
update migration guide to reflect removal of Vibur + Proxool
gavinking Dec 3, 2024
bbd372e
add links to connection pool doc
gavinking Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions documentation/src/main/asciidoc/introduction/Tuning.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ the connection pool.
=== Tuning the connection pool

The connection pool built in to Hibernate is suitable for testing, but isn't intended for use in production.
Instead, Hibernate supports a range of different connection pools, including our favorite, Agroal.
Instead, Hibernate supports several different connection pools, including our favorite, Agroal.

To select and configure Agroal, you'll need to set some extra configuration properties, in addition to the settings we already saw in <<basic-configuration-settings>>.
Properties with the prefix `hibernate.agroal` are passed through to Agroal:
Expand All @@ -48,7 +48,7 @@ hibernate.agroal.reapTimeout PT10s
----

As long as you set at least one property with the prefix `hibernate.agroal`, the `AgroalConnectionProvider` will be selected automatically.
There are many to choose from:
There are many to choose from, as enumerated by link:{doc-javadoc-url}/org/hibernate/cfg/AgroalSettings.html[`AgroalSettings`]:

.Settings for configuring Agroal
[%breakable,cols="37,~"]
Expand All @@ -72,10 +72,13 @@ The following settings are common to all connection pools supported by Hibernate
.Common settings for connection pools
[%breakable,cols="37,~"]
|===
| `hibernate.connection.autocommit` | The default autocommit mode
| `hibernate.connection.isolation` | The default transaction isolation level
| link:{doc-javadoc-url}/org/hibernate/cfg/JdbcSettings.html#AUTOCOMMIT[`hibernate.connection.autocommit`] | The default autocommit mode
| link:{doc-javadoc-url}/org/hibernate/cfg/JdbcSettings.html#ISOLATION[`hibernate.connection.isolation`] | The default transaction isolation level
|===

A popular alternative to Agroal is HikariCP.
Its setting are enumerated by link:{doc-javadoc-url}/org/hibernate/cfg/HikariCPSettings.html[`HikariCPSettings`].

.Container-managed datasources
****
In a container environment, you usually don't need to configure a connection pool through Hibernate.
Expand Down
7 changes: 7 additions & 0 deletions migration-guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,6 +433,12 @@ This was incorrect according to the JPA specification, and inconsistent with the

In Hibernate 7, these SQL `UPDATE` statements only occur if the `@OrderColumn` is _not_ also mapped by a field of the entity.

[[pools]]
== Connection pools

Since Vibur and Proxool are no longer actively developed, support for these connection pools was removed.
Use Agroal or HikariCP instead.

[[cleanup]]
== Cleanup

Expand All @@ -453,6 +459,7 @@ In Hibernate 7, these SQL `UPDATE` statements only occur if the `@OrderColumn` i
** Removed `@LazyCollection`
** Replaced uses of `CacheModeType` with `CacheMode`
** Removed `@TestForIssue` (for testing purposes) -> use `org.hibernate.testing.orm.junit.JiraKey` and `org.hibernate.testing.orm.junit.JiraKeyGroup`
** Removed `@Cache.include` -> use `@Cache.includeLazy`

* Classes/interfaces
** Removed `SqmQualifiedJoin` (all joins are qualified)
Expand Down
Loading