Package org.apache.pinot.segment.local.segment.index.loader.invertedindex

Class TextIndexHandler

java.lang.Object

org.apache.pinot.segment.local.segment.index.loader.invertedindex.TextIndexHandler

All Implemented Interfaces:

IndexHandler

public class TextIndexHandler
extends Object
implements IndexHandler

Helper class for text indexes used by SegmentPreProcessor. to create text index for column during segment load time. Currently text index is always created (if enabled on a column) during segment generation (1) A new segment with text index is created/refreshed. Server loads the segment. The handler detects the existence of text index and returns. (2) A reload is issued on an existing segment with existing text index. The handler detects the existence of text index and returns. (3) A reload is issued on an existing segment after text index is enabled on an existing column. Read the forward index to create text index. (4) A reload is issued on an existing segment after text index is enabled on a newly added column. In this case, the default column handler would have taken care of adding forward index for the new column. Read the forward index to create text index.

Constructor Summary

Constructors

Constructor	Description
TextIndexHandler(SegmentMetadata segmentMetadata, IndexLoadingConfig indexLoadingConfig)

Method Summary

Modifier and Type	Method	Description
boolean	needUpdateIndices(SegmentDirectory.Reader segmentReader)	Check if there is a need to add new indices or removes obsolete indices.
void	updateIndices(SegmentDirectory.Writer segmentWriter, IndexCreatorProvider indexCreatorProvider)	Adds new indices and removes obsolete indices.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextIndexHandler

public TextIndexHandler(SegmentMetadata segmentMetadata,
                        IndexLoadingConfig indexLoadingConfig)

Method Detail

needUpdateIndices

public boolean needUpdateIndices(SegmentDirectory.Reader segmentReader)

Description copied from interface: IndexHandler

Check if there is a need to add new indices or removes obsolete indices.

Specified by:

needUpdateIndices in interface IndexHandler

Returns:

true if there is a need to update.

updateIndices

public void updateIndices(SegmentDirectory.Writer segmentWriter,
                          IndexCreatorProvider indexCreatorProvider)
                   throws Exception

Description copied from interface: IndexHandler

Adds new indices and removes obsolete indices.

Specified by:

updateIndices in interface IndexHandler

Throws:

Exception