Hibernate Search

Documentation

Getting started

Get documentation for 6.2

Documentation per Series

7.0

7.0.0.Beta1 2023-09-05 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

Reference HTML PDF API (JavaDoc)

Getting started guide HTML PDF

Migration guide HTML PDF

6.2

6.2.1.Final 2023-07-07 latest stable

Standalone POJO Mapper, mapping of classes/records to projections using @ProjectionConstructor, highlighting, indexing plan filters to suspend automatic indexing, excludePaths for @IndexedEmbedded, search DSL improvements (including projections on object fields), Elasticsearch schema export, compatibility with Elasticsearch 8.9 and OpenSearch 2.9, upgrade of -orm6 artifacts to Hibernate ORM 6.2.

Reference HTML PDF API (JavaDoc)

Getting started guide HTML PDF

Migration guide HTML PDF

5.11

5.11.12.Final 2023-01-31 limited-support

ORM 5.4 compatibility.

Reference HTML PDF API (JavaDoc)

Getting started guide HTML

Migration guide HTML

See older series

6.1

6.1.8.Final 2023-01-31 limited-support

Asynchronous, distributed automatic indexing, OpenSearch compatibility, search DSL improvements, conditional mass indexing, ORM 5.6, Lucene 8.11, Elasticsearch 7.16, Jakarta EE artifacts, ORM 6 artifacts.

Reference HTML PDF API (JavaDoc)

Getting started guide HTML PDF

Migration guide HTML PDF

6.0

6.0.11.Final 2023-01-31 end-of-life

API overhaul. Safer and more concise Search DSL, more powerful bridges, smarter automatic indexing, nested documents. Upgrades to Lucene 8 and Elasticsearch 7.

Reference HTML PDF API (JavaDoc)

Getting started guide HTML PDF

Migration guide HTML PDF

5.10

5.10.13.Final 2022-10-27 limited-support

ORM 5.3 and JPA 2.2 compatibility, integration to DI frameworks through Hibernate ORM 5.3, upgrade to WildFly 17 and JGroups 4, JPMS automatic module names.

Reference HTML PDF API (JavaDoc)

Migration guide HTML

5.9

5.9.3.Final 2018-09-10 end-of-life

JSR 352 (Batch for Java) mass indexing job, WildFly feature packs, improvements and deprecations paving the road to Search 6

Reference HTML PDF API (JavaDoc)

Migration guide HTML

5.8

5.8.2.Final 2017-10-26 end-of-life

Experimental integration with Elasticsearch 5.x, AWS integration, improvements and deprecations paving the road to Search 6

Reference HTML PDF API (JavaDoc)

Migration guide HTML

5.7

5.7.3.Final 2017-10-26 end-of-life

Improved integration with Elasticsearch 2.x, compatible with Hibernate ORM 5.2.x

Reference HTML PDF API (JavaDoc)

Migration guide HTML

5.6

5.6.6.Final 2018-09-10 end-of-life

Introduces experimental support for Elasticsearch, last release supporting Hibernate ORM 5.0.z or 5.1.z

Reference HTML PDF API (JavaDoc)

Migration guide HTML

5.5

5.5.8.Final 2017-08-16 end-of-life

Being maintained as it's included in WildFly. Supports Lucene only, requires Hibernate ORM 5.0.z or 5.1.z

Reference HTML PDF API (JavaDoc)

Migration guide HTML

5.4

5.4.0.Final 2015-09-03 end-of-life

Requires Hibernate ORM 5.0.0.Final; Last version compatible with Apache Lucene 4.x

Reference HTML PDF API (JavaDoc)

Migration guide HTML

5.3

5.3.0.Final 2015-06-10 end-of-life

Improved Faceting

Reference HTML PDF API (JavaDoc)

Migration guide HTML

5.2

5.2.1.Final 2015-09-04 end-of-life

Multi-tenancy, optimisations in criteria based loaders

Reference HTML PDF API (JavaDoc)

Migration guide HTML

5.1

5.1.2.Final 2015-04-24 end-of-life

Upgrade to Lucene 4 and much much more ...

Reference HTML PDF API (JavaDoc)

Migration guide HTML

5.0

5.0.1.Final 2015-01-12 end-of-life

Upgrade to Lucene 4 and much much more ...

Reference HTML PDF API (JavaDoc)

Migration guide HTML

4.5

4.5.3.Final 2015-01-12 end-of-life

Performance, WildFly 8 compatibility, JPA 2.1 / Hibernate ORM 4.3 compatibility

Reference HTML PDF API (JavaDoc)

Migration guide HTML

4.4

4.4.6.Final 2014-12-02 end-of-life

Dynamic index sharding, new Metadata API, Hibernate ORM 4.2.x compatible

Reference HTML PDF API (JavaDoc)

Migration guide HTML

Other documentation

FAQ: Frequently asked questions.
More resources: Third-party documentation, blog posts, talks and books about Hibernate Search.