Package org.apache.pinot.segment.local.realtime.impl.invertedindex

Class RealtimeLuceneTextIndex

java.lang.Object

org.apache.pinot.segment.local.realtime.impl.invertedindex.RealtimeLuceneTextIndex

All Implemented Interfaces:

Closeable, AutoCloseable, IndexReader, MutableIndex, MutableTextIndex, TextIndexReader

public class RealtimeLuceneTextIndex
extends Object
implements MutableTextIndex

Lucene text index reader supporting near realtime search. An instance of this is created per consuming segment by MutableSegmentImpl. Internally it uses LuceneTextIndexCreator for adding documents to the lucene index as and when they are indexed by the consuming segment.

Constructor Summary

Constructors

Constructor	Description
RealtimeLuceneTextIndex(String column, File segmentIndexDir, String segmentName, List<String> stopWordsInclude, List<String> stopWordsExclude, boolean useCompoundFile, int maxBufferSizeMB)	Created by MutableSegmentImpl for each column on which text index has been enabled

Method Summary

Modifier and Type	Method	Description
void	add(String document)	Adds a new document.
void	add(String[] documents)	Adds a new document, made up of multiple values.
void	close()
org.roaringbitmap.buffer.ImmutableRoaringBitmap	getDictIds(String searchQuery)
org.roaringbitmap.buffer.MutableRoaringBitmap	getDocIds(String searchQuery)
org.apache.lucene.search.SearcherManager	getSearcherManager()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.pinot.segment.spi.index.mutable.MutableTextIndex

add, add

Constructor Detail

RealtimeLuceneTextIndex

public RealtimeLuceneTextIndex(String column,
                               File segmentIndexDir,
                               String segmentName,
                               List<String> stopWordsInclude,
                               List<String> stopWordsExclude,
                               boolean useCompoundFile,
                               int maxBufferSizeMB)

Created by MutableSegmentImpl for each column on which text index has been enabled

Parameters:

column - column name

segmentIndexDir - realtime segment consumer dir

segmentName - realtime segment name

stopWordsInclude - the words to include in addition to the default stop word list

stopWordsExclude - stop words to exclude from default stop words

Method Detail

add

public void add(String document)

Adds a new document.

Specified by:

add in interface MutableTextIndex

add

public void add(String[] documents)

Adds a new document, made up of multiple values.

Specified by:

add in interface MutableTextIndex

getDictIds

public org.roaringbitmap.buffer.ImmutableRoaringBitmap getDictIds(String searchQuery)

Specified by:

getDictIds in interface TextIndexReader

getDocIds

public org.roaringbitmap.buffer.MutableRoaringBitmap getDocIds(String searchQuery)

Specified by:

getDocIds in interface TextIndexReader

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getSearcherManager

public org.apache.lucene.search.SearcherManager getSearcherManager()