MutableSegment (Pinot Segment Service Provider Interface 0.12.1 API)

All Superinterfaces:: IndexSegment

public interface MutableSegment
extends IndexSegment

Method Summary

Modifier and Type	Method	Description
`int`	`getNumDocsIndexed()`	Returns the number of records already indexed into the segment.
`boolean`	`index(GenericRow row, RowMetadata rowMetadata)`	Indexes a record into the segment with optionally provided metadata.

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
  - index
```
boolean index(GenericRow row,
              @Nullable
              RowMetadata rowMetadata)
       throws IOException
```
    Indexes a record into the segment with optionally provided metadata.
    
    Parameters:
    
    row - Record represented as a GenericRow
    
    rowMetadata - the metadata associated with the message
    
    Returns:
    
    Whether the segment is full (i.e. cannot index more record into it)
    
    Throws:
    
    IOException
  - getNumDocsIndexed
```
int getNumDocsIndexed()
```
    Returns the number of records already indexed into the segment.
    
    Returns:
    
    The number of records indexed