5.10 series - Hibernate Search

Hibernate Search 5.10 is in limited support mode:

releases may be delayed until a significant need arises;
bugs will only be fixed if they are considered significant enough or in the context of paid support;
pull requests against this version might be rejected for bugs that are not considered critical enough;
bug reproducers using this version will be given lower priority.

We recommend that you upgrade to a newer series if possible or look for paid support.

Compatibility

Java	8, 11 (with 5.10.7+) or 17 (with 5.10.11+)
Hibernate ORM	5.3
Elasticsearch server	2.0 - 5.6
Apache Lucene	5.5

Not compatible with your requirements? Have a look at the other series.

See also the Compatibility policy and Maintenance policy.

Documentation

Documentation for Hibernate Search 5.10 can be accessed through the links below:

HTML PDF API (JavaDoc)

You can find more documentation for all series on the documentation page.

How to get it

Hibernate Search 5.10 is in limited maintenance mode: we recommend that you upgrade to a newer series if possible or look for paid support.

Maven, Gradle...

Maven artifacts of Hibernate Search are published to Maven Central. Most build tools fetch artifacts from Maven Central by default, but if that's not the case for you, see this page to configure your build tool.

You can find the Maven coordinates of all artifacts through the link below:

Maven artifacts

Below are the Maven coordinates of the main artifacts.

Hibernate ORM integration

Elasticsearch integration

Amazon IAM authentication for Elasticsearch

JGroups backend

JMS backend

JSR 352 (Batch for Java) integration - Core

JSR 352 (Batch for Java) integration - JBeret specifics

WildFly feature pack - Engine

WildFly feature pack - Hibernate ORM integration

WildFly feature pack - Elasticsearch integration

WildFly feature pack - Amazon IAM authentication for Elasticsearch

WildFly feature pack - JGroups backend

All Maven artifacts of this project released after 2022-01-26 are signed.

To verify signed Maven artifacts, head to this page.

Direct download

A ZIP archive containing all JAR files, documentation and source is available from SourceForge:

Download ZIP archive

Individual Maven artifacts may be downloaded directly from the Maven repository:

Maven Central subdirectory

See here for how to download all dependencies of your Maven project to a local directory on your filesystem.

See here for how to download an explicitly listed set of artifacts to a local directory on your filesystem.

More information about specific releases (announcements, download links) can be found here.

Migrating

If you need to upgrade from a previous series, please refer to the migration guide:

HTML

What's new

Latest release announcement (2022-10-27): 5.10.13.Final.

A detailed list of new features, improvements and fixes in this series can be found on our issue tracker.

ORM 5.3 and JPA 2.2 compatibility

Hibernate Search 5.10 is designed to work with Hibernate ORM 5.3.

Integration to DI frameworks through Hibernate ORM 5.3

Hibernate Search now taps into Hibernate ORM’s integration to dependency injection frameworks. If you use a dependency injection framework integrating with Hibernate ORM 5.3, and you add field bridges to your dependency injection context, then Hibernate Search will automatically retrieve and use field bridges from this context.

This allows you in particular to inject components from your DI context into your field bridges, using your DI framework’s features (@java.inject.Inject, Spring’s @Autowired, …).

The integration is known to work in a CDI 2.0 environment such as WildFly 17, and also in Spring 5.

Upgrade to WildFly 17 and JGroups 4

Hibernate Search’s JBoss modules now target WildFly 17. This means in particular that the JGroups backend now uses JGroups 4 and is no longer compatible with JGroups 3.

Also, we took this opportunity to move the JGroups backend’s JBoss modules out of the engine feature pack to a dedicated feature pack.

JPMS automatic module names

We added automatic JPMS module names to our JARs.

Note that Hibernate Search JARs still can only be used as automatic modules, because some of our dependencies cannot easily be used as modules yet.

Here are the module names:

org.hibernate.search.engine
org.hibernate.search.orm
org.hibernate.search.backend.elasticsearch
org.hibernate.search.backend.elasticsearch.aws
org.hibernate.search.clustering.jms
org.hibernate.search.clustering.jgroups
org.hibernate.search.jsr352.core
org.hibernate.search.jsr352.jberet
org.hibernate.search.serialization.avro

Direct access to the Elasticsearch client

Hibernate Search now offers a way to access the Elasticsearch client directly. See the documentation for more information.

Development versions (SNAPSHOTS)

The latest development versions of Maven artifacts for Hibernate Search are published to the OSSRH snapshots repository.

OSSRH snapshots subdirectory

You should only need those (unstable) versions for testing recently merged patches, and should never use them in production.

To consume these artifacts, you may need to configure your build tool to fetch artifacts from https://oss.sonatype.org/content/repositories/snapshots and to enable snapshots:

Maven Gradle

Releases in this series