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, VectorIndexHandler

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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.pinot.segment.spi.index.IndexHandler

IndexHandler.NoOp

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,FieldIndexConfigs>	_fieldIndexConfigs
protected SegmentDirectory	_segmentDirectory
protected TableConfig	_tableConfig
protected Set<String>	_tmpForwardIndexColumns

Constructor Summary

Constructors

Constructor	Description
BaseIndexHandler(SegmentDirectory segmentDirectory, Map<String,FieldIndexConfigs> fieldIndexConfigs, TableConfig tableConfig)
BaseIndexHandler(SegmentDirectory segmentDirectory, IndexLoadingConfig indexLoadingConfig)

Method Summary

Modifier and Type	Method	Description
protected ColumnMetadata	createForwardIndexIfNeeded(SegmentDirectory.Writer segmentWriter, String columnName, boolean isTemporaryForwardIndex)
void	postUpdateIndicesCleanup(SegmentDirectory.Writer segmentWriter)

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.IndexHandler

needUpdateIndices, updateIndices

Field Detail

_tmpForwardIndexColumns

protected final Set<String> _tmpForwardIndexColumns

_segmentDirectory

protected final SegmentDirectory _segmentDirectory

_fieldIndexConfigs

protected final Map<String,FieldIndexConfigs> _fieldIndexConfigs

_tableConfig

@Nullable
protected final TableConfig _tableConfig

Constructor Detail

BaseIndexHandler

public BaseIndexHandler(SegmentDirectory segmentDirectory,
                        IndexLoadingConfig indexLoadingConfig)

BaseIndexHandler

public BaseIndexHandler(SegmentDirectory segmentDirectory,
                        Map<String,FieldIndexConfigs> fieldIndexConfigs,
                        @Nullable
                        TableConfig tableConfig)

Method Detail

postUpdateIndicesCleanup

public void postUpdateIndicesCleanup(SegmentDirectory.Writer segmentWriter)
                              throws Exception

Specified by:

postUpdateIndicesCleanup in interface IndexHandler

Throws:

Exception

createForwardIndexIfNeeded

protected ColumnMetadata createForwardIndexIfNeeded(SegmentDirectory.Writer segmentWriter,
                                                    String columnName,
                                                    boolean isTemporaryForwardIndex)
                                             throws IOException

Throws:

IOException