Hibernate Search

7.0 series development

JDK 11 as a baseline, switch to Jakarta EE, compatibility with ORM 6.3 and no -orm6 artifacts, upgrade to Lucene 9 in the Lucene backend, published Hibernate Search BOM, experimental compatibility with Amazon OpenSearch Serverless, drop compatibility with EOL’d Elasticsearch versions 5.x - 6.x

Compatibility

Java 11, 17 or 21
Hibernate ORM 6.3
Elasticsearch server 7.0 - 8.9
OpenSearch server 1.0 - 2.9
Apache Lucene 9.7

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

See also the Compatibility policy.

Documentation

Documentation for Hibernate Search 7.0 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

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.

org.hibernate.search:hibernate-search-bom:7.0.0.Beta1
Hibernate Search BOM
org.hibernate.search:hibernate-search-mapper-orm:7.0.0.Beta1
Hibernate ORM mapper
org.hibernate.search:hibernate-search-mapper-orm-coordination-outbox-polling:7.0.0.Beta1
"outbox-polling" coordination strategy for the Hibernate ORM mapper
org.hibernate.search:hibernate-search-mapper-pojo-standalone:7.0.0.Beta1
Standalone POJO mapper
org.hibernate.search:hibernate-search-backend-lucene:7.0.0.Beta1
Lucene backend
org.hibernate.search:hibernate-search-backend-elasticsearch:7.0.0.Beta1
Elasticsearch/OpenSearch backend
org.hibernate.search:hibernate-search-backend-elasticsearch-aws:7.0.0.Beta1
Amazon IAM authentication for Elasticsearch/OpenSearch
org.hibernate.search:hibernate-search-mapper-orm-batch-jsr352-core:7.0.0.Beta1
Jakarta Batch mass indexing job for the Hibernate ORM mapper - Core
org.hibernate.search:hibernate-search-mapper-orm-batch-jsr352-jberet:7.0.0.Beta1
Jakarta Batch mass indexing job for the Hibernate ORM mapper - JBeret specifics
org.hibernate.search:hibernate-search-v5migrationhelper-orm:7.0.0.Beta1
Helper for migrating from Hibernate Search 5 to Hibernate Search 6 (Hibernate ORM mapper + Lucene 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.

Getting started

If you want to start using Hibernate Search 7.0, please refer to the getting started guide:

HTML PDF

Migrating

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

HTML PDF

What's new

Hibernate Search 7.0 is still in development:

  • some features may be incomplete;

  • newly introduced features may change in a backward-incompatible way before the stable release.

We encourage you to give it a try and to let us know of any bugs or problems you encounter.

Latest release announcement (2023-09-05): 7.0.0.Beta1.

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

Dependency upgrades

Java

Hibernate Search is now using JDK 11 as a baseline and can work on JDK 11, 17 or 21. Compatibility with JDK 8 was dropped.

Hibernate ORM

Hibernate Search depends on Hibernate ORM 6.3 as it fully switched to Jakarta EE. There are no -orm6/-jakarta artifacts or Java EE compatibility anymore.

Lucene

The Lucene backend now uses Lucene 9.7. Upgrading requires reindexing, see the migration guide for details.

Elasticsearch

The Elasticsearch backend now works with Elasticsearch 8.9 and 7.17 as well as other versions that were already compatible. Compatibility with Elasticsearch 5.x/6.x is removed.

OpenSearch

The Elasticsearch backend now works with OpenSearch 1.3 and 2.9 as well as other versions that were already compatible.

Hibernate Search BOM

Hibernate Search now offers a BOM providing dependency management for all of its published artifacts. It can be imported as part of your dependency management to keep the versions of Hibernate Search artifacts aligned:

<dependencyManagement>
    <dependencies>
        <!-- Import Hibernate Search BOM to get all of its artifact versions aligned: -->
        <dependency>
            <groupId>org.hibernate.search</groupId>
            <artifactId>hibernate-search-bom</artifactId>
            <version>{hibernateSearchVersion}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <!-- Any other dependency management entries -->
    </dependencies>
</dependencyManagement>
<!-- ... -->
<dependencies>
    <!-- Declare dependencies -->
    <dependency>
        <groupId>org.hibernate.search</groupId>
        <artifactId>hibernate-search-mapper-orm</artifactId>
        <!-- The version is managed by the BOM above -->
    </dependency>
    <dependency>
        <groupId>org.hibernate.search</groupId>
        <artifactId>hibernate-search-backend-elasticsearch</artifactId>
        <!-- The version is managed by the BOM above -->
    </dependency>
    <!-- Any other dependency entries -->
</dependencies>

Amazon OpenSearch Serverless experimental compatibility

Hibernate Search now has incubating compatibility with Amazon OpenSearch Serverless.

Amazon OpenSearch Serverless has certain limitations compared to a regular OpenSearch cluster and may not support all operations a regular cluster does. Compatibility with Amazon OpenSearch Serverless must be enabled explicitly by setting the backend version property:

hibernate.search.backend.version=amazon-opensearch-serverless

See this section of the reference documentation for more information, in particular about limitations.

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 and to enable snapshots:

Maven Gradle

Releases in this series

7.0.0.Beta1

2023-09-05

JDK 11 as a baseline, switch to Jakarta EE, compatibility with ORM 6.3 and no -orm6 artifacts, upgrade to Lucene 9 in the Lucene backend, published Hibernate Search BOM, experimental compatibility with Amazon OpenSearch Serverless, drop compatibility with EOL’d Elasticsearch versions 5.x - 6.x

How to get it Getting started

Maven artifacts Download Resolved issues Release announcement

Back to top