Package org.apache.pinot.segment.local.segment.creator.impl

Class DefaultIndexCreatorProvider

java.lang.Object

org.apache.pinot.segment.local.segment.creator.impl.DefaultIndexCreatorProvider

All Implemented Interfaces:

BloomFilterCreatorProvider, ForwardIndexCreatorProvider, GeoSpatialIndexCreatorProvider, IndexCreatorProvider, InvertedIndexCreatorProvider, JsonIndexCreatorProvider, RangeIndexCreatorProvider, TextIndexCreatorProvider

public final class DefaultIndexCreatorProvider
extends Object
implements IndexCreatorProvider

This class centralizes logic for how to create indexes. It can be overridden by SPI {@see IndexCreatorProviders} and should not be constructed directly, but accessed only via {@see IndexCreatorProviders#getIndexCreatorProvider}. Unless a user provides an override, this is the logic which will be used to create each index type.

Constructor Summary

Constructors

Constructor	Description
DefaultIndexCreatorProvider()

Method Summary

Modifier and Type	Method	Description
static ForwardIndexCreator	getRawIndexCreatorForMVColumn(File file, ChunkCompressionType compressionType, String column, FieldSpec.DataType dataType, int totalDocs, int maxNumberOfMultiValueElements, boolean deriveNumDocsPerChunk, int writerVersion, int maxRowLengthInBytes)	Helper method to build the raw index creator for the column.
static ForwardIndexCreator	getRawIndexCreatorForSVColumn(File file, ChunkCompressionType compressionType, String column, FieldSpec.DataType dataType, int totalDocs, int lengthOfLongestEntry, boolean deriveNumDocsPerChunk, int writerVersion)	Helper method to build the raw index creator for the column.
static int	getRawIndexWriterVersion(String columnName, Map<String,Map<String,String>> columnProperties)
BloomFilterCreator	newBloomFilterCreator(IndexCreationContext.BloomFilter context)
ForwardIndexCreator	newForwardIndexCreator(IndexCreationContext.Forward context)
GeoSpatialIndexCreator	newGeoSpatialIndexCreator(IndexCreationContext.Geospatial context)
DictionaryBasedInvertedIndexCreator	newInvertedIndexCreator(IndexCreationContext.Inverted context)
JsonIndexCreator	newJsonIndexCreator(IndexCreationContext.Json context)
CombinedInvertedIndexCreator	newRangeIndexCreator(IndexCreationContext.Range context)
TextIndexCreator	newTextIndexCreator(IndexCreationContext.Text context)
static boolean	shouldDeriveNumDocsPerChunk(String columnName, Map<String,Map<String,String>> columnProperties)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIndexCreatorProvider

public DefaultIndexCreatorProvider()

Method Detail

newForwardIndexCreator

public ForwardIndexCreator newForwardIndexCreator(IndexCreationContext.Forward context)
                                           throws Exception

Specified by:

newForwardIndexCreator in interface ForwardIndexCreatorProvider

Throws:

Exception

newInvertedIndexCreator

public DictionaryBasedInvertedIndexCreator newInvertedIndexCreator(IndexCreationContext.Inverted context)
                                                            throws IOException

Specified by:

newInvertedIndexCreator in interface InvertedIndexCreatorProvider

Throws:

IOException

newJsonIndexCreator

public JsonIndexCreator newJsonIndexCreator(IndexCreationContext.Json context)
                                     throws IOException

Specified by:

newJsonIndexCreator in interface JsonIndexCreatorProvider

Throws:

IOException

newTextIndexCreator

public TextIndexCreator newTextIndexCreator(IndexCreationContext.Text context)
                                     throws IOException

Specified by:

newTextIndexCreator in interface TextIndexCreatorProvider

Throws:

IOException

newGeoSpatialIndexCreator

public GeoSpatialIndexCreator newGeoSpatialIndexCreator(IndexCreationContext.Geospatial context)
                                                 throws IOException

Specified by:

newGeoSpatialIndexCreator in interface GeoSpatialIndexCreatorProvider

Throws:

IOException

shouldDeriveNumDocsPerChunk

public static boolean shouldDeriveNumDocsPerChunk(String columnName,
                                                  Map<String,Map<String,String>> columnProperties)

getRawIndexWriterVersion

public static int getRawIndexWriterVersion(String columnName,
                                           Map<String,Map<String,String>> columnProperties)

getRawIndexCreatorForSVColumn

public static ForwardIndexCreator getRawIndexCreatorForSVColumn(File file,
                                                                ChunkCompressionType compressionType,
                                                                String column,
                                                                FieldSpec.DataType dataType,
                                                                int totalDocs,
                                                                int lengthOfLongestEntry,
                                                                boolean deriveNumDocsPerChunk,
                                                                int writerVersion)
                                                         throws IOException

Helper method to build the raw index creator for the column. Assumes that column to be indexed is single valued.

Parameters:

file - Output index file

column - Column name

totalDocs - Total number of documents to index

lengthOfLongestEntry - Length of longest entry

deriveNumDocsPerChunk - true if varbyte writer should auto-derive the number of rows per chunk

writerVersion - version to use for the raw index writer

Returns:

raw index creator

Throws:

IOException

getRawIndexCreatorForMVColumn

public static ForwardIndexCreator getRawIndexCreatorForMVColumn(File file,
                                                                ChunkCompressionType compressionType,
                                                                String column,
                                                                FieldSpec.DataType dataType,
                                                                int totalDocs,
                                                                int maxNumberOfMultiValueElements,
                                                                boolean deriveNumDocsPerChunk,
                                                                int writerVersion,
                                                                int maxRowLengthInBytes)
                                                         throws IOException

Helper method to build the raw index creator for the column. Assumes that column to be indexed is single valued.

Parameters:

file - Output index file

column - Column name

totalDocs - Total number of documents to index

deriveNumDocsPerChunk - true if varbyte writer should auto-derive the number of rows per chunk

writerVersion - version to use for the raw index writer

maxRowLengthInBytes - the length of the longest row in bytes

Returns:

raw index creator

Throws:

IOException

newBloomFilterCreator

public BloomFilterCreator newBloomFilterCreator(IndexCreationContext.BloomFilter context)
                                         throws IOException

Specified by:

newBloomFilterCreator in interface BloomFilterCreatorProvider

Throws:

IOException

newRangeIndexCreator

public CombinedInvertedIndexCreator newRangeIndexCreator(IndexCreationContext.Range context)
                                                  throws IOException

Specified by:

newRangeIndexCreator in interface RangeIndexCreatorProvider

Throws:

IOException