Class IndexingOverrides.Default
- java.lang.Object
-
- org.apache.pinot.segment.spi.index.IndexingOverrides.Default
-
- All Implemented Interfaces:
BloomFilterCreatorProvider,ForwardIndexCreatorProvider,GeoSpatialIndexCreatorProvider,IndexCreatorProvider,InvertedIndexCreatorProvider,JsonIndexCreatorProvider,RangeIndexCreatorProvider,TextIndexCreatorProvider,IndexingOverrides.IndexingOverride,MutableDictionaryProvider,MutableForwardIndexProvider,MutableIndexProvider,MutableInvertedIndexProvider,MutableJsonIndexProvider,MutableTextIndexReaderProvider,BloomFilterReaderProvider,ForwardIndexReaderProvider,GeospatialIndexReaderProvider,IndexReaderProvider,InvertedIndexReaderProvider,JsonIndexReaderProvider,RangeIndexReaderProvider,SortedIndexReaderProvider,TextIndexReaderProvider
- Enclosing class:
- IndexingOverrides
public static class IndexingOverrides.Default extends Object implements IndexingOverrides.IndexingOverride
Extend this class to override index creation
-
-
Constructor Summary
Constructors Constructor Description Default()
-
Method Summary
-
-
-
Method Detail
-
newBloomFilterCreator
public BloomFilterCreator newBloomFilterCreator(IndexCreationContext.BloomFilter context) throws IOException
Description copied from interface:BloomFilterCreatorProviderCreates a {@see BloomFilterCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.- Specified by:
newBloomFilterCreatorin interfaceBloomFilterCreatorProvider- Parameters:
context- context about the index creation.- Returns:
- a {@see ForwardIndexCreator}
- Throws:
IOException- whenever something goes wrong matching or constructing the creator
-
newForwardIndexCreator
public ForwardIndexCreator newForwardIndexCreator(IndexCreationContext.Forward context) throws Exception
Description copied from interface:ForwardIndexCreatorProviderCreates a {@see ForwardIndexCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.- Specified by:
newForwardIndexCreatorin interfaceForwardIndexCreatorProvider- Parameters:
context- context about the index creation.- Returns:
- a {@see ForwardIndexCreator}
- Throws:
Exception- whenever something goes wrong matching or constructing the creator
-
newGeoSpatialIndexCreator
public GeoSpatialIndexCreator newGeoSpatialIndexCreator(IndexCreationContext.Geospatial context) throws IOException
Description copied from interface:GeoSpatialIndexCreatorProviderCreates a {@see GeoSpatialIndexCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.- Specified by:
newGeoSpatialIndexCreatorin interfaceGeoSpatialIndexCreatorProvider- Parameters:
context- context about the index creation.- Returns:
- a {@see ForwardIndexCreator}
- Throws:
IOException- whenever something goes wrong matching or constructing the creator
-
newInvertedIndexCreator
public DictionaryBasedInvertedIndexCreator newInvertedIndexCreator(IndexCreationContext.Inverted context) throws IOException
Description copied from interface:InvertedIndexCreatorProviderCreates a {@see DictionaryBasedInvertedIndexCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.- Specified by:
newInvertedIndexCreatorin interfaceInvertedIndexCreatorProvider- Parameters:
context- context about the index creation.- Returns:
- a {@see ForwardIndexCreator}
- Throws:
IOException- whenever something goes wrong matching or constructing the creator
-
newJsonIndexCreator
public JsonIndexCreator newJsonIndexCreator(IndexCreationContext.Json context) throws IOException
Description copied from interface:JsonIndexCreatorProviderCreates a {@see JsonIndexCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.- Specified by:
newJsonIndexCreatorin interfaceJsonIndexCreatorProvider- Parameters:
context- context about the index creation.- Returns:
- a {@see ForwardIndexCreator}
- Throws:
IOException- whenever something goes wrong matching or constructing the creator
-
newRangeIndexCreator
public CombinedInvertedIndexCreator newRangeIndexCreator(IndexCreationContext.Range context) throws IOException
Description copied from interface:RangeIndexCreatorProviderCreates a {@see CombinedInvertedIndexCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.- Specified by:
newRangeIndexCreatorin interfaceRangeIndexCreatorProvider- Parameters:
context- context about the index creation.- Returns:
- a {@see ForwardIndexCreator}
- Throws:
IOException- whenever something goes wrong matching or constructing the creator
-
newTextIndexCreator
public TextIndexCreator newTextIndexCreator(IndexCreationContext.Text context) throws IOException
Description copied from interface:TextIndexCreatorProviderCreates a {@see TextIndexCreator} from information about index creation. This allows a plugin to pattern match index creation information to select an appropriate implementation.- Specified by:
newTextIndexCreatorin interfaceTextIndexCreatorProvider- Parameters:
context- context about the index creation.- Returns:
- a {@see ForwardIndexCreator}
- Throws:
IOException- whenever something goes wrong matching or constructing the creator
-
newBloomFilterReader
public BloomFilterReader newBloomFilterReader(PinotDataBuffer dataBuffer, boolean onHeap) throws IOException
Description copied from interface:BloomFilterReaderProviderCreates a {@see BloomFilterReader}- Specified by:
newBloomFilterReaderin interfaceBloomFilterReaderProvider- Parameters:
dataBuffer- the buffer, the caller is responsible for closing itonHeap- whether to duplicate on heap.- Returns:
- a bloom filter reader
- Throws:
IOException- if reading from the buffer fails.
-
newForwardIndexReader
public ForwardIndexReader<?> newForwardIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata) throws IOException
Description copied from interface:ForwardIndexReaderProviderCreates a {@see ForwardIndexReader}- Specified by:
newForwardIndexReaderin interfaceForwardIndexReaderProvider- Parameters:
dataBuffer- the buffer, the caller is responsible for closing itmetadata- the column metadata, may be used to select a reader if the buffer does not start with a magic byte.- Returns:
- a forward index reader
- Throws:
IOException- if reading from the buffer fails.
-
newGeospatialIndexReader
public H3IndexReader newGeospatialIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata) throws IOException
Description copied from interface:GeospatialIndexReaderProviderCreates a {@see H3IndexReader}- Specified by:
newGeospatialIndexReaderin interfaceGeospatialIndexReaderProvider- Parameters:
dataBuffer- the buffer, the caller is responsible for closing itmetadata- the column metadata, may be used to select a reader if the buffer does not start with a magic byte.- Returns:
- a geospatial index reader
- Throws:
IOException- if reading from the buffer fails.
-
newInvertedIndexReader
public InvertedIndexReader<?> newInvertedIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata) throws IOException
Description copied from interface:InvertedIndexReaderProviderCreates a {@see InvertedIndexReader}- Specified by:
newInvertedIndexReaderin interfaceInvertedIndexReaderProvider- Parameters:
dataBuffer- the buffer, the caller is responsible for closing itmetadata- the column metadata, may be used to select a reader if the buffer does not start with a magic byte.- Returns:
- an inverted index reader
- Throws:
IOException- if reading from the buffer fails.
-
newJsonIndexReader
public JsonIndexReader newJsonIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata) throws IOException
Description copied from interface:JsonIndexReaderProviderCreates a {@see JsonIndexReader}- Specified by:
newJsonIndexReaderin interfaceJsonIndexReaderProvider- Parameters:
dataBuffer- the buffer, the caller is responsible for closing itmetadata- the column metadata, may be used to select a reader if the buffer does not start with a magic byte.- Returns:
- a JSON index reader
- Throws:
IOException- if reading from the buffer fails.
-
newRangeIndexReader
public RangeIndexReader<?> newRangeIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata) throws IOException
Description copied from interface:RangeIndexReaderProviderCreates a {@see RangeIndexReader}- Specified by:
newRangeIndexReaderin interfaceRangeIndexReaderProvider- Parameters:
dataBuffer- the buffer, the caller is responsible for closing itmetadata- the column metadata, may be used to select a reader if the buffer does not start with a magic byte.- Returns:
- a range index reader
- Throws:
IOException- if reading from the buffer fails.
-
newSortedIndexReader
public SortedIndexReader<?> newSortedIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata) throws IOException
Description copied from interface:SortedIndexReaderProviderCreates a {@see SortedIndexReader}- Specified by:
newSortedIndexReaderin interfaceSortedIndexReaderProvider- Parameters:
dataBuffer- the buffer, the caller is responsible for closing itmetadata- the column metadata, may be used to select a reader if the buffer does not start with a magic byte.- Returns:
- a sorted index reader
- Throws:
IOException- if reading from the buffer fails.
-
newFSTIndexReader
public TextIndexReader newFSTIndexReader(PinotDataBuffer dataBuffer, ColumnMetadata metadata) throws IOException
Description copied from interface:TextIndexReaderProviderCreates a {@see TextIndexReader}- Specified by:
newFSTIndexReaderin interfaceTextIndexReaderProvider- Parameters:
dataBuffer- the buffer, the caller is responsible for closing itmetadata- the column metadata, may be used to select a reader if the buffer does not start with a magic byte.- Returns:
- a text index reader
- Throws:
IOException- if reading from the buffer fails.
-
newTextIndexReader
public TextIndexReader newTextIndexReader(File file, ColumnMetadata columnMetadata, @Nullable Map<String,String> textIndexProperties)
Description copied from interface:TextIndexReaderProviderCreates a {@see TextIndexReader}- Specified by:
newTextIndexReaderin interfaceTextIndexReaderProvider- Parameters:
file- the filecolumnMetadata- the column metadata, may be used to select a reader if the buffer does not start with a magic byte.- Returns:
- a text index reader
-
newForwardIndex
public MutableForwardIndex newForwardIndex(MutableIndexContext.Forward context)
- Specified by:
newForwardIndexin interfaceMutableForwardIndexProvider
-
newInvertedIndex
public MutableInvertedIndex newInvertedIndex(MutableIndexContext.Inverted context)
- Specified by:
newInvertedIndexin interfaceMutableInvertedIndexProvider
-
newTextIndex
public MutableTextIndex newTextIndex(MutableIndexContext.Text context)
- Specified by:
newTextIndexin interfaceMutableTextIndexReaderProvider
-
newJsonIndex
public MutableJsonIndex newJsonIndex(MutableIndexContext.Json context)
- Specified by:
newJsonIndexin interfaceMutableJsonIndexProvider
-
newDictionary
public MutableDictionary newDictionary(MutableIndexContext.Dictionary context)
- Specified by:
newDictionaryin interfaceMutableDictionaryProvider
-
-