Introduction

The aim of this guide is to assist you migrating an existing application using any version 8.0.x of Hibernate Search to the latest of the 8.1.x series.

If you think something is missing or something does not work, please contact us.

If you’re looking to migrate from an earlier version, you should migrate step-by-step, from one minor version to the next, following the migration guide of each version.

To Hibernate Search 5 users

Be aware that a lot of APIs have changed since Hibernate Search 5, some only because of a package change, others because of more fundamental changes (like moving away from using Lucene types in Hibernate Search APIs).

When migrating from Hibernate Search 5, you are encouraged to migrate first to Hibernate Search 6.0 using the 6.0 migration guide, and only then to later versions (which will be significantly easier).

Requirements

The requirements of Hibernate Search 8.1.1.Final are the same as those of Hibernate Search 8.0.

Artifacts

The coordinates of Maven artifacts in Hibernate Search 8.1.1.Final are the same as in Hibernate Search 8.0.

Data format and schema

Indexes

The index format and schema in Hibernate Search 8.1.1.Final is backward-compatible with Hibernate Search 8.0: older indexes can be read from and written to without reindexing.

Outbox polling database tables

The event and agent database tables used for outbox-polling in Hibernate Search 8.1.1.Final are backward-compatible with Hibernate Search 8.0: no database schema update is necessary for these tables.

Configuration

The configuration properties in Hibernate Search 8.1.1.Final, in general, are backward-compatible with Hibernate Search 8.0.

API

The API in Hibernate Search 8.1.1.Final is, in general, backward-compatible with Hibernate Search 8.0.

  • Metic aggregation countDistinct() is deprecated in favor of an option in the count() aggregation: .count().field(..).distinct().

  • Both JPA and Hibernate ORM query adapters alongside with Search#toJpaQuery and Search#toOrmQuery are deprecated for removal without any alternatives.

SPI

The SPI in Hibernate Search 8.1.1.Final is, in general, backward-compatible with Hibernate Search 8.0.

Behavior

The behavior of Hibernate Search 8.1.1.Final is, in general, backward-compatible with Hibernate Search 8.0.