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

Class FstIndexType

java.lang.Object

org.apache.pinot.segment.spi.index.AbstractIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>

org.apache.pinot.segment.local.segment.index.fst.FstIndexType

All Implemented Interfaces:

ConfigurableFromIndexLoadingConfig<FstIndexConfig>, IndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>

public class FstIndexType
extends AbstractIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>
implements ConfigurableFromIndexLoadingConfig<FstIndexConfig>

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	FstIndexType()

Method Summary

Modifier and Type	Method	Description
ColumnConfigDeserializer<FstIndexConfig>	createDeserializer()
FSTIndexCreator	createIndexCreator(IndexCreationContext context, FstIndexConfig indexConfig)
IndexHandler	createIndexHandler(SegmentDirectory segmentDirectory, Map<String,FieldIndexConfigs> configsByCol, Schema schema, TableConfig tableConfig)
protected IndexReaderFactory<TextIndexReader>	createReaderFactory()
Map<String,FstIndexConfig>	fromIndexLoadingConfig(IndexLoadingConfig indexLoadingConfig)	Returns a map that can be used to get the index config.
FstIndexConfig	getDefaultConfig()
List<String>	getFileExtensions(ColumnMetadata columnMetadata)
Class<FstIndexConfig>	getIndexConfigClass()
String	getPrettyName()
protected void	handleIndexSpecificCleanup(TableConfig tableConfig)
static TextIndexReader	read(PinotDataBuffer dataBuffer, ColumnMetadata metadata)

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

convertToNewFormat, equals, getConfig, getId, getReaderFactory, 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

createMutableIndex, getIndexBuildLifecycle, getIndexReader

Field Detail

INDEX_DISPLAY_NAME

public static final String INDEX_DISPLAY_NAME

See Also:

Constant Field Values

Constructor Detail

FstIndexType

protected FstIndexType()

Method Detail

getIndexConfigClass

public Class<FstIndexConfig> getIndexConfigClass()

Specified by:

getIndexConfigClass in interface IndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>

fromIndexLoadingConfig

public Map<String,FstIndexConfig> 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<FstIndexConfig>

Returns:

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

getDefaultConfig

public FstIndexConfig getDefaultConfig()

Specified by:

getDefaultConfig in interface IndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>

getPrettyName

public String getPrettyName()

Specified by:

getPrettyName in interface IndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>

createDeserializer

public ColumnConfigDeserializer<FstIndexConfig> createDeserializer()

Specified by:

createDeserializer in class AbstractIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>

createIndexCreator

public FSTIndexCreator createIndexCreator(IndexCreationContext context,
                                          FstIndexConfig indexConfig)
                                   throws IOException

Specified by:

createIndexCreator in interface IndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>

Throws:

IOException

createReaderFactory

protected IndexReaderFactory<TextIndexReader> createReaderFactory()

Specified by:

createReaderFactory in class AbstractIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>

read

public static TextIndexReader read(PinotDataBuffer dataBuffer,
                                   ColumnMetadata metadata)
                            throws IndexReaderConstraintException,
                                   IOException

Throws:

IndexReaderConstraintException

IOException

createIndexHandler

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

Specified by:

createIndexHandler in interface IndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>

getFileExtensions

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

Specified by:

getFileExtensions in interface IndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>

handleIndexSpecificCleanup

protected void handleIndexSpecificCleanup(TableConfig tableConfig)

Overrides:

handleIndexSpecificCleanup in class AbstractIndexType<FstIndexConfig,TextIndexReader,FSTIndexCreator>