Package org.apache.pinot.segment.local.segment.readers

Class PinotSegmentRecordReader

java.lang.Object

org.apache.pinot.segment.local.segment.readers.PinotSegmentRecordReader

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, RecordReader

public class PinotSegmentRecordReader
extends Object
implements RecordReader

Record reader for Pinot segment.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PinotSegmentRecordReader()
PinotSegmentRecordReader(File indexDir)	Deprecated.
PinotSegmentRecordReader(File indexDir, Schema schema, List<String> sortOrder)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	close()
void	getRecord(GenericRow reuse, int docId)
int[]	getSortedDocIds()	Returns the sorted document ids.
Object	getValue(int docId, String column)
boolean	hasNext()
void	init(File indexDir, Set<String> fieldsToRead, List<String> sortOrder, boolean skipDefaultNullValues)	Initializes the record reader from an index directory.
void	init(File indexDir, Set<String> fieldsToRead, RecordReaderConfig recordReaderConfig)
void	init(ImmutableSegment immutableSegment)	Initializes the record reader from an immutable segment.
void	init(MutableSegment mutableSegment, int[] sortedDocIds)	Initializes the record reader from a mutable segment.
GenericRow	next()
GenericRow	next(GenericRow reuse)
void	rewind()

Methods inherited from class java.lang.Object

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

Constructor Detail

PinotSegmentRecordReader

public PinotSegmentRecordReader()

PinotSegmentRecordReader

@Deprecated
public PinotSegmentRecordReader(File indexDir)
                         throws Exception

Deprecated.

Deprecated: use empty constructor and init() instead. Read records using the segment schema

Parameters:

indexDir - input path for the segment index

Throws:

Exception

PinotSegmentRecordReader

@Deprecated
public PinotSegmentRecordReader(File indexDir,
                                @Nullable
                                Schema schema,
                                @Nullable
                                List<String> sortOrder)
                         throws Exception

Deprecated.

Deprecated: use empty constructor and init() instead. Read records using the segment schema with the given schema and sort order

Passed in schema must be a subset of the segment schema.

Parameters:

indexDir - input path for the segment index

schema - input schema that is a subset of the segment schema

sortOrder - a list of column names that represent the sorting order

Throws:

Exception

Method Detail

init

public void init(File indexDir,
                 @Nullable
                 Set<String> fieldsToRead,
                 @Nullable
                 RecordReaderConfig recordReaderConfig)

Specified by:

init in interface RecordReader

init

public void init(File indexDir,
                 @Nullable
                 Set<String> fieldsToRead,
                 @Nullable
                 List<String> sortOrder,
                 boolean skipDefaultNullValues)

Initializes the record reader from an index directory.

Parameters:

indexDir - Index directory

fieldsToRead - The fields to read from the segment. If null or empty, reads all fields

sortOrder - List of sorted columns

skipDefaultNullValues - Whether to skip putting default null values into the record

init

public void init(ImmutableSegment immutableSegment)

Initializes the record reader from an immutable segment.

Parameters:

immutableSegment - Immutable segment

init

public void init(MutableSegment mutableSegment,
                 @Nullable
                 int[] sortedDocIds)

Initializes the record reader from a mutable segment. NOTE: The mutable segment should have already finished consumption and ready to be sealed. In order to read records from consuming segment, use IndexSegment.getRecord(int, GenericRow) instead.

Parameters:

mutableSegment - Mutable segment

sortedDocIds - Array of sorted document ids

getSortedDocIds

@Nullable
public int[] getSortedDocIds()

Returns the sorted document ids.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface RecordReader

next

public GenericRow next()

Specified by:

next in interface RecordReader

next

public GenericRow next(GenericRow reuse)

Specified by:

next in interface RecordReader

getRecord

public void getRecord(GenericRow reuse,
                      int docId)

getValue

public Object getValue(int docId,
                       String column)

rewind

public void rewind()

Specified by:

rewind in interface RecordReader

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException