Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Hibernate Search: full-text search for domain model
Java
Failed to load latest commit information.
backends HSEARCH-1938 JGroups tests using String.getBytes without charset
build-config [maven-release-plugin] prepare for next development iteration
distribution HSEARCH-1934 Remove the relocated artifact from our distribution tarb…
documentation HSEARCH-1909 Rename logging category for the FullText-Query category …
engine HSEARCH-1938 Improve the SentenceInventor testing utility to use a ra…
infinispan HSEARCH-1934 Remove the relocated artifact from our distribution tarb…
integrationtest HSEARCH-1938 Apply forbidden API fixes to the WildFly integration tests
legacy [maven-release-plugin] prepare for next development iteration
modules [maven-release-plugin] prepare for next development iteration
orm HSEARCH-1938 Avoid using FileReader as it uses platform default encoding
serialization/avro HSEARCH-1936 do not force storeTermVectorPayloads flag when termVecto…
testing [maven-release-plugin] prepare for next development iteration
.gitattributes HSEARCH-1325 Control line endings with an appropriate .gitattributes …
.gitignore Adding .DS_Store from OS X to .gitignore; Removing CheckStyle rule wh…
README.md Prepare release 5.4.0.CR1
changelog.txt Fix the changelog.txt for version 5.4.0.CR1 which was incomplete
copyright.txt Update the record of copyright holders: copyright.txt
lgpl.txt Move search trunk to the new structure
pom.xml HSEARCH-1939 Upgrade to Hibernate ORM 5.0.0.CR3
settings-example.xml HSEARCH-1370 Removing enterprise repository from the example Maven se…

README.md

Hibernate Search

Version: 5.4.0.CR1

Description

Full text search engines like Apache Lucene are very powerful technologies to add efficient free text search capabilities to applications. However, Lucene suffers several mismatches when dealing with object domain models. Amongst other things indexes have to be kept up to date and mismatches between index structure and domain model as well as query mismatches have to be avoided.

Hibernate Search addresses these shortcomings - it indexes your domain model with the help of a few annotations, takes care of database/index synchronization and brings back regular managed objects from free text queries.

Hibernate Search is using Apache Lucene under the cover.

Requirements

This version of Hibernate Search requires:

  • Hibernate ORM 5.0.x
  • Apache Lucene 4.10.x

Instructions

Maven

Include the following to your dependency list:

<dependency>
   <groupId>org.hibernate</groupId>
   <artifactId>hibernate-search-orm</artifactId>
   <version>5.4.0.CR1</version>
</dependency>

Sourceforge Bundle

Download the distribution bundle from SourceForge and unzip to installation directory. Then read the documentation available in docs/reference.

Building from source

> git clone git@github.com:hibernate/hibernate-search.git
> cd hibernate-search
> mvn clean install -s settings-example.xml

Build options (profiles)

The documentation is based on AsciiDoctor. Per default only the html output is enabled. To also generate the docbok output and build the documentation from there use:

> mvn clean install -Pdocbook -s settings-example.xml

To build the distribution bundle run:

> mvn clean install -Pdocbook,dist -s settings-example.xml

You can also build the above mentioned modules directly by changing into these directories and executing maven in the module directory.

Contributing

If you want to contribute, you find all you need to know in Contributing to Hibernate Search

Source code structure

The project is split in several Maven modules:

  • backends: Remote backends receiving an indexing job and executing it via different protocols.

  • build-config: Code related artefacts like checkstyle rules.

  • distribution: Builds the distribution package.

  • documentation: The project documentation.

  • engine: The engine of the project. Most of the beef is here.

  • infinispan: Backend storing indexes in Infinispan.

  • integrationtest: Integration tests with various technologies like WildFly, Spring or Karaf. Also includes performance tests.

  • legacy: Old Maven GAV kept for backward compatibility.

  • modules: Integration with WildFly using JBoss Modules.

  • orm: Native integration for Hibernate ORM.

  • serialization: Serialization code used by remote backends.

  • testing: Various helper classes to write tests using Hibernate Search. This module is semi private.

Contact

Latest Documentation:

Bug Reports:

Free Technical Support:

License

This software and its documentation are distributed under the terms of the FSF Lesser GNU Public License (see lgpl.txt).

Something went wrong with that request. Please try again.