Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-14646 Updating the migration guide for 5.5

This commit is contained in:
Sanne Grinovero 2021-06-02 15:44:15 +01:00
parent 828afd348d
commit 6c3afbed95
1 changed files with 14 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
migration-guide.adoc
View File

@ -1,7 +1,7 @@
= 5.4 Migration Guide
= 5.5 Migration Guide
:toc:
This guide discusses migration from Hibernate ORM version 5.3 to version 5.4. For migration from
This guide discusses migration from Hibernate ORM version 5.4 to version 5.5. For migration from
earlier versions, see any other pertinent migration guides as well.
== Background
@ -9,33 +9,21 @@ earlier versions, see any other pertinent migration guides as well.
== Known changes
=== Overriding Delayed Identity Insert Behavior
This version is very similar to Hibernate ORM 5.4; essentially it includes all bugfixes that have been
applied to the 5.4 maintenance releases, and on top of this it introduces support for the Jakarta Persistence
API (in addition the the JPA APIs we already support).
In Hibernate 5.3, we added support for `DelayedPostInsertIdentifier` behavior to be influenced based on the
`FlushMode` or `FlushModeType` values, in short enhancing Extended PersistenceContext support. Unfortunately,
there were a few side effects that were recently reported with this change.
In Hibernate 5.4, we wanted to preserve as much of the 5.3 behavior as possible and only restore very specific
`DelayedPostInsertIdentifier` behavior for selected use cases.
=== Dom4J based XML mapping
We understand mappings can be complex and there very well could be a corner case we didn't consider. In order
to make 5.4 as flexible with these changes as possible, we added a configuration option that you can use as a
_temporary_ solution to completely disable the 5.3 behavior, reverting it back to 5.2 and prior.
The implementation of Hibernate's parsing of XML mapping definitions has been entirely reimplemented based on
JAXB rather than DOM4J, making progress to remove this ancient dependency.
No specific issues are known at this time.
`hibernate.id.disable_delayed_identity_inserts=true`
=== Removed the ability to disable "enhanced proxies"
If you find you need to use this configuration setting, be sure to report the mapping to us in a JIRA issue so
that we can review it and determine if the mapping corner case should be included in our algorithm since the
configuration setting is meant to bridge behavior support for this across a few releases.
The "enhanced proxies" feature has been introduced as a performance improving feature in 5.3 initially, at
which time it was optional.
=== Hibernate Spatial depends on JTS 1.16
Hibernate Spatial depends on the https://github.com/locationtech/jts[Java Topology Suite (JTS)]. In 5.4 this
dependency has been upgraded to version 1.16. This implies a change in package naming:
all `com.vividsolutions.jts.\*` packages have been renamed to `org.locationtech.jts.*`.
See https://github.com/locationtech/jts/blob/master/MIGRATION.md[the JTS Migration guide] for more information.
=== SQL Server JDBC Driver version upgrade to at least 6.1.2
Due to fixing https://hibernate.atlassian.net/browse/HHH-12973[HHH-12973], you need to upgrade the JDBC Driver version to at least 6.1.2. Due to https://github.com/Microsoft/mssql-jdbc/issues/91[this bug], the older versions of the SQL Server JDBC Driver cannot introspect the `INFORMATION_SCHEMA.SEQUENCES` without closing the database connection.
Since then, many more corner cases have been fixed and this feature is now always enabled. Enjoy the improvements!
No changes are expected to be needed in user code to benefit from this.