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

Class VectorIndexType

java.lang.Object

org.apache.pinot.segment.spi.index.AbstractIndexType<VectorIndexConfig,VectorIndexReader,VectorIndexCreator>

org.apache.pinot.segment.local.segment.index.vector.VectorIndexType

All Implemented Interfaces:

ConfigurableFromIndexLoadingConfig<VectorIndexConfig>, IndexType<VectorIndexConfig,VectorIndexReader,VectorIndexCreator>

public class VectorIndexType
extends AbstractIndexType<VectorIndexConfig,VectorIndexReader,VectorIndexCreator>
implements ConfigurableFromIndexLoadingConfig<VectorIndexConfig>

Index type for vector columns. Currently only supports for float array columns and the supported vector index type is: HNSW.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VectorIndexType.IndexType

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

Method Summary

Modifier and Type	Method	Description
ColumnConfigDeserializer<VectorIndexConfig>	createDeserializer()
VectorIndexCreator	createIndexCreator(IndexCreationContext context, VectorIndexConfig indexConfig)
IndexHandler	createIndexHandler(SegmentDirectory segmentDirectory, Map<String,FieldIndexConfigs> configsByCol, Schema schema, TableConfig tableConfig)
MutableIndex	createMutableIndex(MutableIndexContext context, VectorIndexConfig config)
protected IndexReaderFactory<VectorIndexReader>	createReaderFactory()
Map<String,VectorIndexConfig>	fromIndexLoadingConfig(IndexLoadingConfig indexLoadingConfig)	Returns a map that can be used to get the index config.
VectorIndexConfig	getDefaultConfig()
List<String>	getFileExtensions(ColumnMetadata columnMetadata)
Class<VectorIndexConfig>	getIndexConfigClass()
String	getPrettyName()

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

VectorIndexType

protected VectorIndexType()

Method Detail

getIndexConfigClass

public Class<VectorIndexConfig> getIndexConfigClass()

Specified by:

getIndexConfigClass in interface IndexType<VectorIndexConfig,VectorIndexReader,VectorIndexCreator>

fromIndexLoadingConfig

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

Returns:

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

getDefaultConfig

public VectorIndexConfig getDefaultConfig()

Specified by:

getDefaultConfig in interface IndexType<VectorIndexConfig,VectorIndexReader,VectorIndexCreator>

getPrettyName

public String getPrettyName()

Specified by:

getPrettyName in interface IndexType<VectorIndexConfig,VectorIndexReader,VectorIndexCreator>

createDeserializer

public ColumnConfigDeserializer<VectorIndexConfig> createDeserializer()

Specified by:

createDeserializer in class AbstractIndexType<VectorIndexConfig,VectorIndexReader,VectorIndexCreator>

createIndexCreator

public VectorIndexCreator createIndexCreator(IndexCreationContext context,
                                             VectorIndexConfig indexConfig)
                                      throws IOException

Specified by:

createIndexCreator in interface IndexType<VectorIndexConfig,VectorIndexReader,VectorIndexCreator>

Throws:

IOException

createReaderFactory

protected IndexReaderFactory<VectorIndexReader> createReaderFactory()

Specified by:

createReaderFactory in class AbstractIndexType<VectorIndexConfig,VectorIndexReader,VectorIndexCreator>

createIndexHandler

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

Specified by:

createIndexHandler in interface IndexType<VectorIndexConfig,VectorIndexReader,VectorIndexCreator>

getFileExtensions

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

Specified by:

getFileExtensions in interface IndexType<VectorIndexConfig,VectorIndexReader,VectorIndexCreator>

createMutableIndex

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

Specified by:

createMutableIndex in interface IndexType<VectorIndexConfig,VectorIndexReader,VectorIndexCreator>