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

Class BaseIndexHandler

java.lang.Object

org.apache.pinot.segment.local.segment.index.loader.BaseIndexHandler

All Implemented Interfaces:

IndexHandler

Direct Known Subclasses:

BloomFilterHandler, ForwardIndexHandler, FSTIndexHandler, H3IndexHandler, InvertedIndexHandler, JsonIndexHandler, RangeIndexHandler, TextIndexHandler

public abstract class BaseIndexHandler
extends Object
implements IndexHandler

Base class for all of the IndexHandler classes. This class provides a mechanism to rebuild the forward index if the forward index does not exist and is required to rebuild the index of interest. It also handles cleaning up the forward index if temporarily built once all handlers have completed via overriding the postUpdateIndicesCleanup() method. For IndexHandler classes which do not utilize the forward index or do not need this behavior, the postUpdateIndicesCleanup() method can be overridden to be a no-op.

Field Summary

Fields

Modifier and Type	Field	Description
protected IndexLoadingConfig	_indexLoadingConfig
protected SegmentMetadata	_segmentMetadata
protected Set<String>	_tmpForwardIndexColumns

Constructor Summary

Constructors

Constructor	Description
BaseIndexHandler(SegmentMetadata segmentMetadata, IndexLoadingConfig indexLoadingConfig)

Method Summary

Modifier and Type	Method	Description
protected void	createForwardIndexIfNeeded(SegmentDirectory.Writer segmentWriter, ColumnMetadata columnMetadata, IndexCreatorProvider indexCreatorProvider, boolean isTemporaryForwardIndex)
void	postUpdateIndicesCleanup(SegmentDirectory.Writer segmentWriter)	Performs any cleanup actions required after the indexes have been updated.

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.local.segment.index.loader.IndexHandler

needUpdateIndices, updateIndices

Field Detail

_segmentMetadata

protected final SegmentMetadata _segmentMetadata

_indexLoadingConfig

protected final IndexLoadingConfig _indexLoadingConfig

_tmpForwardIndexColumns

protected final Set<String> _tmpForwardIndexColumns

Constructor Detail

BaseIndexHandler

public BaseIndexHandler(SegmentMetadata segmentMetadata,
                        IndexLoadingConfig indexLoadingConfig)

Method Detail

postUpdateIndicesCleanup

public void postUpdateIndicesCleanup(SegmentDirectory.Writer segmentWriter)
                              throws Exception

Description copied from interface: IndexHandler

Performs any cleanup actions required after the indexes have been updated. Should be called only after all IndexHandlers have run.

Specified by:

postUpdateIndicesCleanup in interface IndexHandler

Throws:

Exception

createForwardIndexIfNeeded

protected void createForwardIndexIfNeeded(SegmentDirectory.Writer segmentWriter,
                                          ColumnMetadata columnMetadata,
                                          IndexCreatorProvider indexCreatorProvider,
                                          boolean isTemporaryForwardIndex)
                                   throws IOException

Throws:

IOException