Hibernate Search

6.0 series development

API refresh, Bridge 2.0, Lucene 8, Elasticsearch 7.

Compatibility

Java 8, 11 or 12
Hibernate ORM 5.4 (>= 5.4.4.Final)
Elasticsearch 5.6 - 7.3
Apache Lucene 8.2

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

Documentation

Documentation for this specific series 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 and to the JBoss Maven repository. Refer to the Maven Getting Started guide on the JBoss Wiki for more information on how to configure the JBoss Maven repository.

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-mapper-orm:6.0.0.Alpha9
Hibernate ORM mapper
org.hibernate.search:hibernate-search-backend-lucene:6.0.0.Alpha9
Lucene backend
org.hibernate.search:hibernate-search-backend-elasticsearch:6.0.0.Alpha9
Elasticsearch backend
org.hibernate.search:hibernate-search-backend-elasticsearch-aws:6.0.0.Alpha9
Amazon IAM authentication for Elasticsearch

Zip archive

Direct download is available from SourceForge:

Download Zip archive

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

What's new

Latest release announcement (2019-08-26): 6.0.0.Alpha9.

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

Preview status

Hibernate Search 6.0 is currently a technology preview.

While the core of Hibernate Search 6 is ready for use in a production environment, there are still some limitations:

  • APIs are not considered completely stable yet.

  • Some of the less frequently used features from Hibernate Search 5 are still missing.

  • There may still be some performance bottlenecks.

If you encounter problems, be sure to report them: new preview versions are released regularly.

The exact features that are currently implemented and expected to work will be added to the reference documentation as new Alpha versions are released, but to sum up, here is what you can start to play with:

  • ORM integration:

    • Mapping of entities using either annotation mapping or programmatic mapping. However, we do not offer all the options that were available in Search 5 (yet). Most of the field types supported in Search 5 are supported in Search 6.

    • Automatic indexing of ORM entities on transaction commit or session flush (if outside of a transaction) (enabled automatically if Hibernate Search is in your classpath and the entity is @Indexed).

    • Mass indexing of ORM entities that are already persisted in database.

    • Searching for ORM entities using their Hibernate Search index, and retrieving managed entities as results.

    • Custom, user-defined type bridges, property bridges or value bridges.

  • Search DSL

    • All the predicates available in Search 5, except facet and moreLikeThis. Additionally, the new id, nested and exists predicates were added. See the part of the documentation about the predicate DSL.

    • All the sorts available in Search 5. See the part of the documentation about the sort DSL.

    • All the projections available in Search 5. See the part of the documentation about the projection DSL.

ORM version

Hibernate Search 6 still relies on ORM 5.4 at the moment, because it requires features that are not yet implemented in ORM 6 (still in development).

Note that only Hibernate ORM 5.4.4.Final or later will work correctly; 5.4.3.Final and earlier will not.

Lucene 8

The Lucene backend now uses Lucene 8.2.

Elasticsearch 7

The Elasticsearch backend now works with Elasticsearch 5.6, 6.8 or 7.3. Support for older versions of Elasticsearch was dropped.

API refresh

A lot of APIs have been changed, for multiple reasons.

More consistent API types

The API types consistently use the Search prefix: no more mixing FullText with Search or simply no prefix.

Additionally, the SearchQuery type (previously FullTextQuery) now defines its own methods instead of extending JPA’s TypeQuery, allowing for an API that makes more sense considering that an index, not a database, is being targeted. It is still possible to create an adapter that implements JPA’s TypeQuery.

No more Lucene in Hibernate Search APIs

Hibernate Search APIs now abstract from the Lucene APIs, so that alternative backends such as Elasticsearch can be used without having Lucene on your classpath.

This should also allow us to upgrade the Lucene version more easily: in Search 5, as Lucene was "part of" our APIs, we were severely limited when we wanted to upgrade to a newer Lucene version, because any breaking change in Lucene could mean a breaking change for our users, too. Now that using Lucene APIs is no longer necessary to use Hibernate Search, upgrades should be faster.

New Search DSL

The Search DSL is brand new, with several improvements:

  • Ability to use lambdas for more concise query definition, even when queries are complex.

  • Type-safe projections thanks to the brand new projection DSL.

  • Various new features and improvements such as a new exists predicate, the ability to override analyzers on a per-predicate basis, …​

  • Injection of native predicates (org.apache.lucene.search.Query, JSON for Elasticsearch) within DSL-created predicates. This is not new for the Lucene integration, but it is for the Elasticsearch integration. See org.hibernate.search.engine.search.dsl.query.SearchQueryHitTypeStep.extension(…​) org.hibernate.search.backend.elasticsearch.ElasticsearchExtension.get() and org.hibernate.search.backend.lucene.LuceneExtension.get().

  • Simpler syntax for predicates when targeting multiple types in a single query: instantiating multiple QueryBuilders is no longer needed, Hibernate Search takes into account that multiple types are targeted and automatically checks that targeted fields are compatible across all targeted indexes.

Bridge 2.0

The bridge APIs had to change as part of the API refresh, so we took this opportunity to overhaul bridge APIs to make bridges more powerful.

The new Bridge APIs are completely different, but with a lot of improvements:

  • Custom (user-defined) bridge annotations, allowing to pass type-safe parameters, and not just strings.

  • Better support for dirty checking optimization in bridges (in TypeBridge in particular), by allowing bridges to declare what parts of the entity they use.

  • Predicates on non-String fields will work without having to bypass bridges (.ignoreFieldBridge()) like in Search 5.

  • And more!

Easier to use, safer automatic indexing

Automatic indexing improvements are not limited to bridges: @IndexedEmbedded is easier to configure properly in Search 6, too.

To be precise, changes on indexed-embedded entities trigger reindexing of the "embedding" entity automatically, and annotating the inverse side of the association with @ContainedIn is no longer needed in most cases. A mapping error will be reported when the inverse side of the association cannot be resolved.

Runtime joins

Hibernate Search 6.0 introduces "nested" fields and predicates, similar to the feature with the same name in Elasticsearch.

See org.hibernate.search.mapper.pojo.mapping.definition.annotation.IndexedEmbedded.storage and org.hibernate.search.engine.search.dsl.predicate.SearchPredicateFactoryContext.nested().

Migrate

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

Releases in this series

6.0.0.Alpha9

2019-08-26

Correct handling of session flushing and clearing, static sharding, upgrades to Elasticsearch 7.3, Lucene 8.2 and Hibernate ORM 5.4.4.Final

org.hibernate.search:hibernate-search-mapper-orm:6.0.0.Alpha9

Maven artifacts Download Resolved issues Release announcement

6.0.0.Alpha8

2019-07-22

Restored configuration options for entity loading and Lucene index storage, simpler and more powerful bridge APIs, upgrades to Elasticsearch 7.2 and Lucene 8.1

org.hibernate.search:hibernate-search-mapper-orm:6.0.0.Alpha8

Maven artifacts Download Resolved issues Release announcement

6.0.0.Alpha7

2019-06-24

Missing index field type parameters restored, explicit indexing APIs restored, upgrade to Elasticsearch 6.8 and 7.1.

org.hibernate.search:hibernate-search-mapper-orm:6.0.0.Alpha7

Maven artifacts Download Resolved issues Release announcement

6.0.0.Alpha6

2019-05-27

Decent performance for Lucene index access, indexing BigDecimal and BigInteger, less verbose search DSL, configuration of on-commit synchronization for automatic indexing, other bugfixes and improvements.

org.hibernate.search:hibernate-search-mapper-orm:6.0.0.Alpha6

Maven artifacts Download Resolved issues Release announcement

6.0.0.Alpha5

2019-05-02

"indexNullAs" feature restored, API to declare dependencies in bridges, Elasticsearch 6.7 and 7.0, other bugfixes and improvements.

org.hibernate.search:hibernate-search-mapper-orm:6.0.0.Alpha5

Maven artifacts Download Resolved issues Release announcement

6.0.0.Alpha4

2019-04-05

"exists" predicate, DSL converter bypass and analyzer override in predicates, upgrade to Lucene 8, Elasticsearch AWS integration restored, other bugfixes and improvements.

org.hibernate.search:hibernate-search-mapper-orm:6.0.0.Alpha4

Maven artifacts Download Resolved issues Release announcement

6.0.0.Alpha3

2019-03-22

More field types, more predicates, more consistent and less verbose API, other bugfixes and improvements.

org.hibernate.search:hibernate-search-mapper-orm:6.0.0.Alpha3

Maven artifacts Download Resolved issues Release announcement

6.0.0.Alpha2

2019-01-31

Mass indexer, Elasticsearch index lifecycle, efficient work orchestration in Elasticsearch, more projections, shorter annotation names, settings improvements.

org.hibernate.search:hibernate-search-mapper-orm:6.0.0.Alpha2

Maven artifacts Download Resolved issues Release announcement

6.0.0.Alpha1

2018-11-29

Initial implementation: a few field types only, a few predicates/sorts/projections only, sub-optimal work orchestration, minimal documentation.

org.hibernate.search:hibernate-search-mapper-orm:6.0.0.Alpha1

Maven artifacts Download Resolved issues Release announcement

Back to top