6.2 Migration Guide
6.2 Migration Guide
2 Migration Guide
Table of Contents
DDL type changes
OffsetTime mapping changes
UUID mapping changes on MariaDB
UUID mapping changes on SQL Server
JSON mapping changes on Oracle
JSON mapping changes on H2
Datatype for enums
Timezone and offset storage
Byte[]/Character[] mapping changes
Check constraints for boolean and enum mappings
UNIQUE constraint for optional one-to-one mappings
Column type inference for number(n,0) in native SQL queries on Oracle
Removal of support for legacy database versions
Changes to CDI handling
Change enhancement defaults and deprecation
API / SPI / Internal distinction
org.hibernate.cfg package
org.hibernate.loader package
Changes in integration contracts (SPIs)
EntityPersister#lock
EntityPersister#multiLoad
Executable#afterDeserialize
JdbcType#getJdbcRecommendedJavaTypeMapping()
Query Path comparison
Batch Fetching and LockMode
Integrating Static Metamodel Generation
Native query with joins
This guide discusses migration to Hibernate ORM version 6.2. For migration from earlier versions, see
any other pertinent migration guides as well.
https://docs.jboss.org/hibernate/orm/6.2/migration-guide/migration-guide.html 1/9
09/01/2025, 00:09 6.2 Migration Guide
If the target database supports time zone types natively like H2, Oracle, SQL Server and DB2 z/OS, the type code
SqlTypes.TIME_WITH_TIMEZONE is now used, which maps to the DDL type time with time zone .
Due to this change, schema validation errors could occur on existing databases.
The migration to time with time zone requires a migration expression like cast(old as time with time zone) which will interpret
the previous time as local time and compute the offset for the time with time zone based on the current date and time zone
settings of your database session.
If the target database does not support time zone types natively, Hibernate behaves just like before.
The migration to blob and json requires a migration expression like cast(old as blob) and cast(old as json) respectively.
To get the old behavior, annotate the column with @Column(definition = "clob") .
This change was done because blob and json are way more efficient and because we don’t expect wide usage of SqlTypes.JSON
yet.
https://docs.jboss.org/hibernate/orm/6.2/migration-guide/migration-guide.html 2/9
09/01/2025, 00:09 6.2 Migration Guide
The migration to json requires a migration expression like cast(old as json) . Note that this change in behavior is backwards
compatible and you do not need to change your schema, unless you are running into schema validation errors and want to fix
them.
To get the old behavior, annotate the column with @Column(definition = "clob") .
This change was done because the native json type is more efficient and because we don’t expect wide usage of SqlTypes.JSON
yet.
NOTE
On MySQL, enums are now stored using the ENUM datatype by default
if the database/dialect supports it, time zones of date/time values are stored by using the timestamp with time zone SQL column
type;
otherwise, time zones of date/time values are not stored, and date/time values are normalized to UTC.
In Hibernate ORM 5, time zones were not stored, but normalized to the time zone set in hibernate.jdbc.time_zone , the JVM time
zone by default.
This discrepancy might lead to incorrect date/time being loaded from the database for properties of type OffsetDateTime and
ZonedDateTime if your application was migrated from Hibernate ORM 5 and was setting hibernate.jdbc.time_zone to a non-UTC
timezone.
To revert to Hibernate ORM 5’s behavior, set the configuration property hibernate.timezone.default_storage to NORMALIZE .
Hibernate historically allowed mapping Byte[] and Character[] in a domain model as basic values to VARBINARY and (N)VARCHAR
SQL types.
Strictly speaking, this is an inaccurate mapping. Because the Java wrapper types ( Byte and Character ) are used, null elements
are allowed. However, it is not possible to store such domain values as VARBINARY and (N)VARCHAR SQL types. In fact, attempting
to store such values leads to errors on previous versions. The legacy support has an implicit contract that the Byte[] and
Character[] types are handled exactly the same as the byte[] and char[] variants.
DISALLOW
(default) Throw an informative and actionable error
https://docs.jboss.org/hibernate/orm/6.2/migration-guide/migration-guide.html 3/9
09/01/2025, 00:09 6.2 Migration Guide
ALLOW
Allows the use of the wrapper arrays stored as structured SQL types ( ARRAY , SQLXML , …) to maintain proper null element
semantics.
LEGACY
Allows the use of the wrapper arrays stored as VARBINARY and VARCHAR , disallowing null elements.
See AvailableSettings#WRAPPER_ARRAY_HANDLING
(https://docs.jboss.org/hibernate/orm/6.2/javadocs/org/hibernate/cfg/AvailableSettings.html#WRAPPER_ARRAY_HANDLING)
The main idea here is for applications using these types in the domain model to make a conscious decision about how these
values are stored.
Some mappings are considered implicit opt-in to the legacy behavior; e.g. using @Lob or @Nationalized
4. Specify hibernate.type.wrapper_array_handling=allow . If the schema is legacy, migrate the database schema to use a structured
SQL type. E.g.
a. Execute alter table tbl rename column array_col to array_col_old to have the old format available
b. Execute alter table tbl add column array_col DATATYPE array to add the column like the new mapping expects it to be
c. Run the query select t.primary_key, t.array_col_old from table t to extract byte[] or String
d. For every result, load the Hibernate entity by primary key and set the field value to transformed result Byte[] or
Character[]
e. Finally, drop the old column alter table tbl drop column array_col_old
Often the association can also be remapped using @ManyToOne + @UniqueConstraint instead.
Since Hibernate 6.0, columns of type number with scale 0 on Oracle were interpreted as boolean , tinyint , smallint , int , or
bigint , depending on the precision.
https://docs.jboss.org/hibernate/orm/6.2/migration-guide/migration-guide.html 4/9
09/01/2025, 00:09 6.2 Migration Guide
Now, columns of type number with scale 0 are interpreted as int or bigint depending on the precision.
This version introduces the concept of minimum supported database version for most of the database dialects that Hibernate
supports. This implies that the legacy code for versions that are no longer supported by their vendors, has been removed from
the hibernate-core module. It is, however, still available in the hibernate-community-dialects module, just under a different
package, namely org.hibernate.community.dialect instead of org.hibernate.dialect . Note that this also includes version specific
dialects like PostgreSQL81Dialect , MariaDB102Dialect etc.
MySQL 5.7
DB2 10.5
DB2i 7.1
DB2z 12.1
MariaDB 10.3
H2 1.4.197
Derby 10.14.2
Sybase 16.0
CockroachDB 21.1
PostgreSQL 10.0
Oracle 11.2
HSQLDB 2.6.1
Hibernate also has the ability to resolve some of its extension points using the CDI BeanManager . Version 6.2 adds a new boolean
hibernate.cdi.extensions setting to control this:
true
indicates to use the CDI BeanManager to resolve these extensions
false
(the default) indicates to not use the CDI BeanManager to resolve these extensions
https://docs.jboss.org/hibernate/orm/6.2/migration-guide/migration-guide.html 5/9
09/01/2025, 00:09 6.2 Migration Guide
The previous behavior was to always load the extensions from CDI if it was available. However, this can sometimes lead to
timing issues with the BeanManager not being ready for use when we need those extension beans. Starting with 6.2, these
extensions will only be resolved from the CDI BeanManager if hibernate.cdi.extensions is set to true.
The enableLazyInitialization and enableDirtyTracking enhancement tooling options in the ANT task, Maven Plugin and Gradle
Plugin, as well as the respective hibernate.enhancer.enableLazyInitialization and hibernate.enhancer.enableDirtyTracking
configuration settings, switched their default values to true and the settings are now deprecated for removal without
replacement. See HHH-15641 (https://hibernate.atlassian.net/browse/HHH-15641) for details.
The global property hibernate.bytecode.use_reflection_optimizer switched the default value to true and the setting is now
deprecated for removal without replacement. See HHH-15631 (https://hibernate.atlassian.net/browse/HHH-15631) for details.
org.hibernate.cfg package
The org.hibernate.cfg package has been especially egregious in mixing APIs and internals historically. The only true API
contracts in this package include org.hibernate.cfg.AvailableSettings and org.hibernate.cfg.Configuration which have been left
in place.
Additionally, while it is considered an internal detail, org.hibernate.cfg.Environment has also been left in place as many
applications have historically used it rather than org.hibernate.cfg.AvailableSettings .
A number of contracts are considered deprecated and have been left in place.
The rest have been moved under the org.hibernate.boot package where they more properly belong.
org.hibernate.loader package
Most of the org.hibernate.loader package is really an SPI centered around org.hibernate.loader.ast which supports loading
entities and collections by various types of keys - primary-key, unique-key, foreign-key and natural-key. org.hibernate.loader.ast
has already been previously well-defined in terms of SPI / internal split.
These are not considered public API so should not affect end-user (application developer’s) code but such changes might break
integration with other libraries which integrate with Hibernate ORM.
During the development of Hibernate ORM 6.2 the following SPIs have seen some modifications:
https://docs.jboss.org/hibernate/orm/6.2/migration-guide/migration-guide.html 6/9
09/01/2025, 00:09 6.2 Migration Guide
EntityPersister#lock
Changed from EntityPersister#lock(Object, Object, Object, LockMode, SharedSessionContractImplementor) to
EntityPersister#lock(Object, Object, Object, LockMode, EventSource) . This should be trivial to fix as EventSource and
SharedSessionContractImplementor are both contracts of the SessionImpl ; to help transition we recommend using the methods
isEventSource and asEventSource , available on the `SharedSessionContractImplementor`contract.
N.B. method asEventSource will throw an exception for non-compatible type; but because of previous restrictions all invocations
to lock actually had to be compatible: this is now made cleared with the signature change.
EntityPersister#multiLoad
The same change was applieed to multiLoad(Object[] ids, SharedSessionContractImplementor session, MultiIdLoadOptions
loadOptions) , now migrated to multiLoad(Object[] ids, EventSource session, MultiIdLoadOptions loadOptions)
Executable#afterDeserialize
As in the previous two cases, the parameter now accepts EventSource instead of SharedSessionContractImplementor .
JdbcType#getJdbcRecommendedJavaTypeMapping()
The return type of JdbcType#getJdbcRecommendedJavaTypeMapping() was changed from BasicJavaType to JavaType . Even though this
is a source compatible change, it breaks binary backwards compatibility. We decided that it is fine to do this though, as this is a
new minor version.
T1 == T2
T1 instanceof T2 or T2 instanceof T1
T1 or T2 is unknown
Widening/Coercion usually refers to e.g. widening an integer to a long, but can also mean that a string constant can be
interpreted as enum when comparing against an enum attribute.
Note that a comparison of a temporal attribute against a string literal worked before
SQL
from MyEntity e where e.temporalAttribute > '2020-01-01'
SQL
from MyEntity e where e.temporalAttribute > date 2020-01-01
https://docs.jboss.org/hibernate/orm/6.2/migration-guide/migration-guide.html 7/9
09/01/2025, 00:09 6.2 Migration Guide
When LockMode is greater than READ Hibernate does not execute the batch fetching so existing uninitialized proxies will not be
initialized. This because the lock mode is different from the one of the proxies in the batch fetch queue.
E.g.
The integration of static metamodel generation in a project has changed; the recommended way to do this now is by harnessing
the annotation processor classpath. This is true for both gradle and maven.
Check out the specific sections in the User Guide for a guideline on how to do this for Gradle
(https://docs.jboss.org/hibernate/orm/6.2/userguide/html_single/Hibernate_User_Guide.html#tooling-gradle-modelgen) or Maven
(https://docs.jboss.org/hibernate/orm/6.2/userguide/html_single/Hibernate_User_Guide.html#tooling-maven-modelgen).
A Native query that uses a result set mapping, explicit or implicitly by specifying an entity class as result type to
createNativeQuery , requires unique select item aliases. If the native query contains a join to a table with same named columns, a
query that e.g. does select * from .. will lead to an error. If the desire is to select only columns for the result type entity, prefix
the * with a tables alias e.g. select p.* from …
E.g.
@Entity
class Person {
@Id
private Long id;
@OneToMany(mappedBy = "person")
private Set<Dog> dogs = new HashSet<>( 0 );
}
@Entity
class Dog {
@Id
private Long id;
}
Queries like
session.createNativeQuery(
"SELECT * FROM person p LEFT JOIN dog d on d.person_id = p.id", Person.class )
.getResultList();
https://docs.jboss.org/hibernate/orm/6.2/migration-guide/migration-guide.html 8/9
09/01/2025, 00:09 6.2 Migration Guide
have to be changed to
session.createNativeQuery(
"SELECT p.* FROM person p LEFT JOIN dog d on d.person_id = p.id", Person.class )
.getResultList();
1. A "true" one-to-one mapping is one in which both sides use the same primary-key value and the foreign-key is defined on the primary-key
column to the other primary-key column. A "logical" one-to-one is really a many-to-one with a UNIQUE contraint on the key-side of the
foreign-key. See link:https://docs.jboss.org/hibernate/orm/6.2/userguide/html_single/Hibernate_User_Guide.html#associations for more
information
Version 6.2.32.Final
Last updated 2024-10-02 13:43:32 UTC
https://docs.jboss.org/hibernate/orm/6.2/migration-guide/migration-guide.html 9/9