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

Class ForwardIndexCreatorFactory

java.lang.Object

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

public class ForwardIndexCreatorFactory
extends Object

Method Summary

Modifier and Type	Method	Description
static ForwardIndexCreator	createIndexCreator(IndexCreationContext context, ForwardIndexConfig indexConfig)
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.

Methods inherited from class java.lang.Object

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

Method Detail

createIndexCreator

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

Throws:

Exception

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 multi-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