ImmutableSegment (Pinot Segment Service Provider Interface 0.12.1 API)

All Superinterfaces:: IndexSegment

public interface ImmutableSegment
extends IndexSegment

Method Summary

Modifier and Type	Method	Description
`Dictionary`	`getDictionary(String column)`	Returns the dictionary for the given column.
`ForwardIndexReader`	`getForwardIndex(String column)`	Returns the forward index for the given column.
`InvertedIndexReader`	`getInvertedIndex(String column)`	Returns the inverted index for the given column.
`long`	`getSegmentSizeBytes()`	Returns the total size of the segment in bytes.
`String`	`getTier()`	Get the storage tier of the immutable segment.

Methods inherited from interface org.apache.pinot.segment.spi.IndexSegment
acquire, destroy, getColumnNames, getDataSource, getPhysicalColumnNames, getRecord, getSegmentMetadata, getSegmentName, getStarTrees, getValidDocIds, getValue, prefetch, release

- Method Detail
  - getDictionary
```
Dictionary getDictionary(String column)
```
    Returns the dictionary for the given column.
    
    Parameters:
    
    column - Column name
    
    Returns:
    
    Dictionary for the given column, or null if the given column does not have one
  - getForwardIndex
```
ForwardIndexReader getForwardIndex(String column)
```
    Returns the forward index for the given column.
    
    Parameters:
    
    column - Column name
    
    Returns:
    
    Forward index for the given column
  - getInvertedIndex
```
InvertedIndexReader getInvertedIndex(String column)
```
    Returns the inverted index for the given column.
    
    Parameters:
    
    column - Column name
    
    Returns:
    
    Inverted index for the given column, or null if the given column does not have one
  - getSegmentSizeBytes
```
long getSegmentSizeBytes()
```
    Returns the total size of the segment in bytes.
    
    Returns:
    
    Size of the segment in bytes
  - getTier
```
@Nullable
String getTier()
```
    Get the storage tier of the immutable segment.
    
    Returns:
    
    storage tier, null by default.