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

Class ForwardIndexType

java.lang.Object

org.apache.pinot.segment.spi.index.AbstractIndexType<ForwardIndexConfig,ForwardIndexReader,ForwardIndexCreator>

org.apache.pinot.segment.local.segment.index.forward.ForwardIndexType

All Implemented Interfaces:

ConfigurableFromIndexLoadingConfig<ForwardIndexConfig>, IndexType<ForwardIndexConfig,ForwardIndexReader,ForwardIndexCreator>

public class ForwardIndexType
extends AbstractIndexType<ForwardIndexConfig,ForwardIndexReader,ForwardIndexCreator>
implements ConfigurableFromIndexLoadingConfig<ForwardIndexConfig>

Nested Class Summary

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

IndexType.BuildLifecycle

Field Summary

Fields

Modifier and Type	Field	Description
static String	INDEX_DISPLAY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ForwardIndexType()

Method Summary

Modifier and Type	Method	Description
ColumnConfigDeserializer<ForwardIndexConfig>	createDeserializer()
ForwardIndexCreator	createIndexCreator(IndexCreationContext context, ForwardIndexConfig indexConfig)
IndexHandler	createIndexHandler(SegmentDirectory segmentDirectory, Map<String,FieldIndexConfigs> configsByCol, Schema schema, TableConfig tableConfig)
MutableIndex	createMutableIndex(MutableIndexContext context, ForwardIndexConfig config)
protected IndexReaderFactory<ForwardIndexReader>	createReaderFactory()
Map<String,ForwardIndexConfig>	fromIndexLoadingConfig(IndexLoadingConfig indexLoadingConfig)	Returns a map that can be used to get the index config.
static ChunkCompressionType	getDefaultCompressionType(FieldSpec.FieldType fieldType)
ForwardIndexConfig	getDefaultConfig()
String	getFileExtension(ColumnMetadata columnMetadata)
List<String>	getFileExtensions(ColumnMetadata columnMetadata)
Class<ForwardIndexConfig>	getIndexConfigClass()
String	getPrettyName()
static ForwardIndexReader	read(PinotDataBuffer dataBuffer, ColumnMetadata metadata)	Returns the forward index reader for the given column.
static ForwardIndexReader<?>	read(SegmentDirectory.Reader segmentReader, ColumnMetadata columnMetadata)	Returns the forward index reader for the given column.
static ForwardIndexReader<?>	read(SegmentDirectory.Reader segmentReader, FieldIndexConfigs fieldIndexConfigs, ColumnMetadata metadata)	Returns the forward index reader for the given column.

Methods inherited from class org.apache.pinot.segment.spi.index.AbstractIndexType

convertToNewFormat, equals, getConfig, getId, getReaderFactory, handleIndexSpecificCleanup, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.pinot.segment.spi.index.IndexType

getIndexBuildLifecycle, getIndexReader

Field Detail

INDEX_DISPLAY_NAME

public static final String INDEX_DISPLAY_NAME

See Also:

Constant Field Values

Constructor Detail

ForwardIndexType

protected ForwardIndexType()

Method Detail

getIndexConfigClass

public Class<ForwardIndexConfig> getIndexConfigClass()

Specified by:

getIndexConfigClass in interface IndexType<ForwardIndexConfig,ForwardIndexReader,ForwardIndexCreator>

fromIndexLoadingConfig

public Map<String,ForwardIndexConfig> fromIndexLoadingConfig(IndexLoadingConfig indexLoadingConfig)

Description copied from interface: ConfigurableFromIndexLoadingConfig

Returns a map that can be used to get the index config. This map is used with higher priority whenever the index configuration needs to be read from an IndexLoadingConfig. Sometimes IndexLoadingConfig is not completely configured and IndexLoadingConfig.getAllKnownColumns() does not return all columns in the table. Therefore the returned map may not have an entry for each column in the actual schema.

Specified by:

fromIndexLoadingConfig in interface ConfigurableFromIndexLoadingConfig<ForwardIndexConfig>

Returns:

a map whose keys are the column names and the values are the index configuration for that column.

getDefaultConfig

public ForwardIndexConfig getDefaultConfig()

Specified by:

getDefaultConfig in interface IndexType<ForwardIndexConfig,ForwardIndexReader,ForwardIndexCreator>

getPrettyName

public String getPrettyName()

Specified by:

getPrettyName in interface IndexType<ForwardIndexConfig,ForwardIndexReader,ForwardIndexCreator>

createDeserializer

public ColumnConfigDeserializer<ForwardIndexConfig> createDeserializer()

Specified by:

createDeserializer in class AbstractIndexType<ForwardIndexConfig,ForwardIndexReader,ForwardIndexCreator>

getDefaultCompressionType

public static ChunkCompressionType getDefaultCompressionType(FieldSpec.FieldType fieldType)

createIndexCreator

public ForwardIndexCreator createIndexCreator(IndexCreationContext context,
                                              ForwardIndexConfig indexConfig)
                                       throws Exception

Specified by:

createIndexCreator in interface IndexType<ForwardIndexConfig,ForwardIndexReader,ForwardIndexCreator>

Throws:

Exception

createIndexHandler

public IndexHandler createIndexHandler(SegmentDirectory segmentDirectory,
                                       Map<String,FieldIndexConfigs> configsByCol,
                                       @Nullable
                                       Schema schema,
                                       @Nullable
                                       TableConfig tableConfig)

Specified by:

createIndexHandler in interface IndexType<ForwardIndexConfig,ForwardIndexReader,ForwardIndexCreator>

createReaderFactory

protected IndexReaderFactory<ForwardIndexReader> createReaderFactory()

Specified by:

createReaderFactory in class AbstractIndexType<ForwardIndexConfig,ForwardIndexReader,ForwardIndexCreator>

getFileExtension

public String getFileExtension(ColumnMetadata columnMetadata)

getFileExtensions

public List<String> getFileExtensions(@Nullable
                                      ColumnMetadata columnMetadata)

Specified by:

getFileExtensions in interface IndexType<ForwardIndexConfig,ForwardIndexReader,ForwardIndexCreator>

read

public static ForwardIndexReader<?> read(SegmentDirectory.Reader segmentReader,
                                         ColumnMetadata columnMetadata)
                                  throws IOException

Returns the forward index reader for the given column. This method will return the default reader, skipping any index overload.

Throws:

IOException

read

public static ForwardIndexReader read(PinotDataBuffer dataBuffer,
                                      ColumnMetadata metadata)

Returns the forward index reader for the given column. This method will return the default reader, skipping any index overload.

read

public static ForwardIndexReader<?> read(SegmentDirectory.Reader segmentReader,
                                         FieldIndexConfigs fieldIndexConfigs,
                                         ColumnMetadata metadata)
                                  throws IndexReaderConstraintException,
                                         IOException

Returns the forward index reader for the given column. This method will delegate on StandardIndexes, so the correct reader will be returned even when using index overload.

Throws:

IndexReaderConstraintException

IOException

createMutableIndex

@Nullable
public MutableIndex createMutableIndex(MutableIndexContext context,
                                       ForwardIndexConfig config)

Specified by:

createMutableIndex in interface IndexType<ForwardIndexConfig,ForwardIndexReader,ForwardIndexCreator>