Hibernate Search

7.0 series end-of-life

JDK 11 as a baseline, switch to Jakarta EE, compatibility with ORM 6.4 without -orm6 artifacts, compatibility with Elasticsearch 8.10/8.11 and OpenSearch 2.9/2.10/2.11, upgrade to Lucene 9 in the Lucene backend, published Hibernate Search BOM, experimental compatibility with Amazon OpenSearch Serverless, dropped compatibility with EOL’d Elasticsearch versions 5.x, 6.x, 7.0-7.9 and OpenSearch versions 1.0-1.2, other bugfixes and improvements

Compatibility

Java 11, 17 or 21
Hibernate ORM 6.4
Elasticsearch server 7.10 - 8.11
OpenSearch server 1.3 - 2.11
Apache Lucene 9.8

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 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

Hibernate Search 7.0 has reached its end-of-life: we recommend that you upgrade to a newer series if possible.

See also the Maintenance policy.

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

Hibernate Search 7.0 has reached its end-of-life: we recommend that you upgrade to a newer series if possible.

See also the Maintenance policy.

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

Latest release announcement (2023-12-05): 7.0.0.Final.

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 now depends on Hibernate ORM 6.4 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.8. Upgrading requires reindexing, see the migration guide for details.

Elasticsearch

The Elasticsearch backend works with Elasticsearch 8.10/8.11 as well as other versions that were already compatible — except for the following versions whose compatibility was dropped, because they already reached their end of life:

  • 5.x/6.x

  • 7.0-7.9

OpenSearch

The Elasticsearch backend works with OpenSearch 2.10 and 2.11 as well as other versions that were already compatible — except for versions 1.0, 1.1 and 1.2 whose compatibility was dropped, because they already reached their end of life.

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>7.0.0.Final</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.

Compatibility with Hibernate ORM’s discriminator-based multi-tenancy

Hibernate Search can now index Hibernate ORM entities that take advantage of discriminator-based multi-tenancy in the database (@TenandId).

Maven artifact renamings

Some Hibernate Search Maven artifacts have been renamed:

  • Maven artifacts related to JSR-352 artifacts were renamed to reflect the move to the Jakarta EE specification:

    • hibernate-search-mapper-orm-batch-jsr352-core was renamed to hibernate-search-mapper-orm-jakarta-batch-core.

    • hibernate-search-mapper-orm-batch-jsr352-jberet was renamed to hibernate-search-mapper-orm-jakarta-batch-jberet.

  • The artifact hibernate-search-mapper-orm-coordination-outbox-polling was renamed to hibernate-search-mapper-orm-outbox-polling.

Releases in this series

Hibernate Search 7.0 has reached its end-of-life: we recommend that you upgrade to a newer series if possible.

See also the Maintenance policy.

7.0.0.CR2

2023-11-24

Compatibility with Elasticsearch 8.11, upgrade to Hibernate ORM 6.4.0.Final, other bugfixes and improvements

Maven artifacts Download Resolved issues Release announcement

7.0.0.CR1

2023-10-23

Compatibility with Hibernate ORM’s discriminator-based multi-tenancy, compatibility with Elasticsearch 8.10 and OpenSearch 2.9/2.10/2.11, dropped compatibility with EOL’d Elasticsearch versions 7.0-7.9 and OpenSearch versions 1.0-1.2, upgrade to Hibernate ORM 6.3.1.Final, upgrade to Lucene 9.8, some Maven artifact renamings, other bugfixes and improvements

Maven artifacts Download Resolved issues Release announcement

7.0.0.Beta1

2023-09-05

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

Maven artifacts Download Resolved issues Release announcement

Back to top