Package org.apache.geode.cache.lucene

This package provides an integration with Apache Lucene that allows Geode regions to be indexed in a distributed Lucene index and queries using Lucene queries.

See: Description

Interface Summary

Interface	Description
LuceneIndex	An lucene index is built over the data stored in a GemFire Region.
LuceneQuery<K,V>	Provides wrapper object of Lucene's Query object and execute the search.
LuceneQueryFactory	Factory for creating instances of LuceneQuery.
LuceneQueryProvider	The instances of this class will be used for distributing Lucene Query objects and re-constructing the Query object.
LuceneResultStruct<K,V>	Abstract data structure for one item in query result.
LuceneService	LuceneService instance is a singleton for each cache.
PageableLuceneQueryResults<K,V>	Defines the interface for a container of lucene query result collected from function execution.

Class Summary

Class	Description
LuceneServiceProvider	Class for retrieving or creating the currently running instance of the LuceneService.

Exception Summary

Exception	Description
LuceneQueryException	Thrown when a lucene query fails.

Package org.apache.geode.cache.lucene Description

This package provides an integration with Apache Lucene that allows Geode regions to be indexed in a distributed Lucene index and queries using Lucene queries.

All indexing and query operations are performed through the LuceneService class. See LuceneService for an example of how to add a lucene index to a geode region.

The Lucene indexes created using this API are stored in geode and colocated with the indexed region, which means they have the same availability guarantees as the underlying region. The indexes are maintained asynchronously, so changes to the region may not be immediately visible in the lucene index.