Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hibernate/hibernate-search

Hibernate Search: full-text search for domain model
https://github.com/hibernate/hibernate-search

elasticsearch hibernate hibernate-search java lucene orm

Last synced: about 3 hours ago
JSON representation

Hibernate Search: full-text search for domain model

Host: GitHub
URL: https://github.com/hibernate/hibernate-search
Owner: hibernate
License: other
Created: 2010-10-15T15:55:09.000Z (almost 14 years ago)
Default Branch: main
Last Pushed: 2024-04-12T16:48:58.000Z (6 months ago)
Last Synced: 2024-04-14T02:43:44.920Z (5 months ago)
Topics: elasticsearch, hibernate, hibernate-search, java, lucene, orm
Language: Java
Homepage: http://hibernate.org/search/
Size: 102 MB
Stars: 488
Watchers: 35
Forks: 241
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
- Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        # Hibernate Search

[![Maven Central](https://img.shields.io/maven-central/v/org.hibernate.search/hibernate-search-mapper-orm.svg?label=Maven%20Central&style=for-the-badge)](https://central.sonatype.com/search?namespace=org.hibernate.search&sort=name)

[![Build Status](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.hibernate.org%2Fjob%2Fhibernate-search%2Fjob%2Fmain%2F&style=for-the-badge)](https://ci.hibernate.org/job/hibernate-search/job/main)

[![Sonar Coverage](https://img.shields.io/sonar/coverage/org.hibernate.search:hibernate-search-parent?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge)](https://sonarcloud.io/project/activity?id=org.hibernate.search%3Ahibernate-search-parent&graph=coverage)

[![Quality gate](https://img.shields.io/sonar/alert_status/org.hibernate.search:hibernate-search-parent?logo=sonarcloud&server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge)](https://sonarcloud.io/dashboard?id=org.hibernate.search%3Ahibernate-search-parent)

[![Develocity](https://img.shields.io/badge/Revved%20up%20by-Develocity-06A0CE?style=for-the-badge&logo=gradle)](https://ge.hibernate.org/scans?search.rootProjectNames=Hibernate%20Search)

[![Reproducible Builds](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/jvm-repo-rebuild/reproducible-central/master/content/org/hibernate/search/hibernate-search-bom/badge.json&style=for-the-badge)](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/org/hibernate/search/hibernate-search-bom/README.md)

## Description

Hibernate Search automatically extracts data from Hibernate ORM entities to push it to

local [Apache Lucene](http://lucene.apache.org/) indexes

or remote [Elasticsearch](https://www.elastic.co/products/elasticsearch)/[OpenSearch](https://www.opensearch.org/) indexes.

It features:

* [**Declarative mapping**](https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#mapper-orm-mapping)

of entity properties to index fields,

either through annotations or a programmatic API.

* [**On-demand mass indexing**](https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#mapper-orm-indexing-massindexer)

of all entities in the database,

to initialize the indexes with pre-existing data.

* [**On-the-fly listener-triggered indexing**](https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#listener-triggered-indexing)

of entities modified through a Hibernate ORM session,

to always keep the indexes up-to-date.

* [**A Search DSL**](https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#search-dsl)

to easily build full-text search queries

and retrieve the hits as Hibernate ORM entities.

* And more: [configuration of analyzers](https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#concepts-analysis),

many different [predicates](https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#search-dsl-predicate)

and [sorts](https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#search-dsl-sort)

in the Search DSL,

[spatial support](https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#mapper-orm-geopoint).

search queries returning [projections](https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#search-dsl-projection)

instead of entities,

[aggregations](https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#search-dsl-aggregation),

advanced customization of the mapping using [bridges](https://docs.jboss.org/hibernate/stable/search/reference/en-US/html_single/#mapper-orm-bridge),

...

For example, map your entities like this:

```java

@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 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 books = new HashSet<>();

    // Getters and setters

    // ...

}

```

Index existing data like this:

```java

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:

```java

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:

```java

SearchResult result = Search.session( entityManager )

        .search( Book.class )

        .where( f -> f.match()

                .fields( "title", "authors.name" )

                .matching( "Isaac" ) )

        .fetch( 20 );

List 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)](https://www.apache.org/licenses/LICENSE-2.0.txt).

The Apache-2.0 license text is included verbatim in the [`LICENSE.txt`](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](https://github.com/hibernate/hibernate-search/tree/7.1#license).

## Getting started

Getting started guides are available

[here](https://hibernate.org/search/documentation/getting-started/).

Fore more information, refer to the Hibernate Search website:

* [Available versions and compatibility matrix](https://hibernate.org/search/releases/)

* [Reference documentation for all versions (current and past)](https://hibernate.org/search/documentation/)

For offline use, distribution bundles downloaded from [SourceForge](https://sourceforge.net/projects/hibernate/files/hibernate-search/)

also include the reference documentation for the downloaded version in PDF and HTML format. 

## Contact

### Latest Documentation

See .

### Bug Reports

See the HSEARCH project on the Hibernate JIRA instance: .

### Community Support

See .

## Contributing

New contributors are always welcome.

See [CONTRIBUTING.md](CONTRIBUTING.md) to get started.

The contribution guide also includes build instructions.