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

Class BaseDefaultColumnHandler

java.lang.Object

org.apache.pinot.segment.local.segment.index.loader.defaultcolumn.BaseDefaultColumnHandler

All Implemented Interfaces:

DefaultColumnHandler

Direct Known Subclasses:

V1DefaultColumnHandler, V3DefaultColumnHandler

public abstract class BaseDefaultColumnHandler
extends Object
implements DefaultColumnHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BaseDefaultColumnHandler.DefaultColumnAction

Field Summary

Fields

Modifier and Type	Field	Description
protected File	_indexDir
protected IndexLoadingConfig	_indexLoadingConfig
protected Schema	_schema
protected SegmentMetadata	_segmentMetadata
protected SegmentDirectory.Writer	_segmentWriter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseDefaultColumnHandler(File indexDir, SegmentMetadata segmentMetadata, IndexLoadingConfig indexLoadingConfig, Schema schema, SegmentDirectory.Writer segmentWriter)

Method Summary

Modifier and Type	Method	Description
protected boolean	createColumnV1Indices(String column)	Helper method to create the V1 indices (dictionary and forward index) for a column, returns true if the creation succeeds, false otherwise.
protected boolean	isForwardIndexDisabled(String column)	Check and return whether the forward index is disabled for a given column
boolean	needUpdateDefaultColumns()	Check if there is a need to add/remove/update the auto-generated default columns for the segment, according to the current table schema.
protected void	removeColumnIndices(String column)	Helper method to remove the indices (dictionary and forward index) for a default column.
protected abstract boolean	updateDefaultColumn(String column, BaseDefaultColumnHandler.DefaultColumnAction action)	Helper method to update default column indices, returns true if the update succeeds, false otherwise.
void	updateDefaultColumns()	Update the auto-generated default columns.

Methods inherited from class java.lang.Object

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

Field Detail

_indexDir

protected final File _indexDir

_segmentMetadata

protected final SegmentMetadata _segmentMetadata

_indexLoadingConfig

protected final IndexLoadingConfig _indexLoadingConfig

_schema

protected final Schema _schema

_segmentWriter

protected final SegmentDirectory.Writer _segmentWriter

Constructor Detail

BaseDefaultColumnHandler

protected BaseDefaultColumnHandler(File indexDir,
                                   SegmentMetadata segmentMetadata,
                                   IndexLoadingConfig indexLoadingConfig,
                                   Schema schema,
                                   SegmentDirectory.Writer segmentWriter)

Method Detail

needUpdateDefaultColumns

public boolean needUpdateDefaultColumns()

Description copied from interface: DefaultColumnHandler

Check if there is a need to add/remove/update the auto-generated default columns for the segment, according to the current table schema.

Specified by:

needUpdateDefaultColumns in interface DefaultColumnHandler

Returns:

true if there is a need to update.

updateDefaultColumns

public void updateDefaultColumns()
                          throws Exception

Update the auto-generated default columns.

Supported default column actions include: ADD/UPDATE/REMOVE DIMENSION/METRIC

Specified by:

updateDefaultColumns in interface DefaultColumnHandler

Throws:

Exception

updateDefaultColumn

protected abstract boolean updateDefaultColumn(String column,
                                               BaseDefaultColumnHandler.DefaultColumnAction action)
                                        throws Exception

Helper method to update default column indices, returns true if the update succeeds, false otherwise.

Throws:

Exception

removeColumnIndices

protected void removeColumnIndices(String column)
                            throws IOException

Helper method to remove the indices (dictionary and forward index) for a default column.

Parameters:

column - column name.

Throws:

IOException

createColumnV1Indices

protected boolean createColumnV1Indices(String column)
                                 throws Exception

Helper method to create the V1 indices (dictionary and forward index) for a column, returns true if the creation succeeds, false otherwise.

Throws:

Exception

isForwardIndexDisabled

protected boolean isForwardIndexDisabled(String column)

Check and return whether the forward index is disabled for a given column