Hibernate Search

Description

Hibernate Search automatically extracts data from Hibernate ORM entities to push it to
local Apache Lucene indexes
or remote Elasticsearch/OpenSearch indexes.

It features:

Declarative mapping
of entity properties to index fields,
either through annotations or a programmatic API.
On-demand mass indexing
of all entities in the database,
to initialize the indexes with pre-existing data.
On-the-fly listener-triggered indexing
of entities modified through a Hibernate ORM session,
to always keep the indexes up-to-date.
A Search DSL
to easily build full-text search queries
and retrieve the hits as Hibernate ORM entities.
And more: configuration of analyzers,
many different predicates
and sorts
in the Search DSL,
spatial support.
search queries returning projections
instead of entities,
aggregations,
advanced customization of the mapping using bridges,
…

For example, map your entities like this:

@Entity
// This entity is mapped to an index
@Indexed
public class Book {
    // The entity ID is the document ID
    @Id
    @GeneratedValue
    private Integer id;
    // This property is mapped to a document field
    @FullTextField
    private String title;
    @ManyToMany
    // Authors will be embedded in Book documents
    @IndexedEmbedded
    private Set<Author> authors = new HashSet<>();
    // Getters and setters
    // ...
}
@Entity
public class Author {
    @Id
    @GeneratedValue
    private Integer id;
    // This property is mapped to a document field
    @FullTextField
    private String name;
    @ManyToMany(mappedBy = "authors")
    private Set<Book> books = new HashSet<>();
    // Getters and setters
    // ...
}

Index existing data like this:

SearchSession searchSession = Search.session( entityManager );
MassIndexer indexer = searchSession.massIndexer( Book.class );
indexer.startAndWait();

Listener-triggered indexing does not require any change to code based on JPA or Hibernate ORM:

Author author = new Author();
author.setName( "Isaac Asimov" );
Book book = new Book();
book.setTitle( "The Caves Of Steel" );
book.getAuthors().add( author );
author.getBooks().add( book );
entityManager.persist( author );
entityManager.persist( book );

And search like this:

SearchResult<Book> result = Search.session( entityManager )
        .search( Book.class )
        .where( f -> f.match()
                .fields( "title", "authors.name" )
                .matching( "Isaac" ) )
        .fetch( 20 );
List<Book> hits = result.hits();
long totalHitCount = result.total().hitCount();

License

This software and its documentation are distributed under the terms of
the Apache License version 2.0 (Apache-2.0).

The Apache-2.0 license text is included verbatim in the LICENSE.txt file
in the root directory of the repository.

Note that Hibernate Search 7.2.0.Alpha1 and lower are distributed under a different license;
for more information, check the licensing information provided alongside published binaries,
or the corresponding branch in the source repository.

Getting started

Getting started guides are available
here.

Fore more information, refer to the Hibernate Search website:

For offline use, distribution bundles downloaded from SourceForge
also include the reference documentation for the downloaded version in PDF and HTML format.

Contact

Latest Documentation

See https://hibernate.org/search/documentation.

Bug Reports

See the HSEARCH project on the Hibernate JIRA instance: https://hibernate.atlassian.net/browse/HSEARCH.

Community Support

See https://hibernate.org/community.

Contributing

New contributors are always welcome.

See CONTRIBUTING.md to get started.

The contribution guide also includes build instructions.