Hibernate Search

Migration Guide from Hibernate Search 5.6 to 5.7

Here we are helping you migrate your existing Search application to the latest and greatest.

Upgrade to Hibernate Search 5.7.x from 5.6.x

The aim of this guide is to assist you migrating an existing application using any version 5.6.x of Hibernate Search to the latest of the 5.7.x series. If you’re looking to migrate different versions see Hibernate Search migration guides.

This document provides pointers for a migration. It refers to Hibernate Search version 5.7.0.Final. If you think something is missing or something does not work, please contact us.


This version of Hibernate Search now requires using Hibernate ORM versions from the 5.2.x family, but starting from version 5.2.3. Versions 5.2.0, 5.2.1, 5.2.2 should be avoided. The recommended version for Hibernate Search 5.7.0.Final is Hibernate ORM 5.2.8.Final.

This implies it now requires Java SE version 8, as that’s the base requirement for all Hibernate ORM 5.2 versions.

API changes

There have been no relevant API changes within Hibernate Search itself; consider though that the new version of Hibernate ORM introduced some very minor changes in API, especially as now org.hibernate.Session implements javax.persistence.EntityManager rather than requiring an adapter, as it did in previous versions.

Running on WildFly 10?

The version of Hibernate ORM in WildFly is now too old to run this version of Hibernate Search. Make sure you read the related chapters of both projects to update the WildFly modules:

Back to top