org.apache.hadoop.hive.ql.io.orc.encoded

Interface EncodedReader

public interface EncodedReader

Method Summary

Modifier and Type	Method and Description
void	close() Closes the reader.
void	preReadDataRanges(DiskRangeList ranges) Reads the encoded data from ORC file by disk ranges and populates the cache.
void	readEncodedColumns(int stripeIx, org.apache.orc.StripeInformation stripe, org.apache.orc.OrcProto.RowIndex[] index, List<org.apache.orc.OrcProto.ColumnEncoding> encodings, List<org.apache.orc.OrcProto.Stream> streams, boolean[] physicalFileIncludes, boolean[] rgs, Consumer<Reader.OrcEncodedColumnBatch> consumer) Reads encoded data from ORC file.
void	readIndexStreams(org.apache.orc.impl.OrcIndex index, org.apache.orc.StripeInformation stripe, List<org.apache.orc.OrcProto.Stream> streams, boolean[] included, boolean[] sargColumns) Read the indexes from ORC file.
void	setStopped(AtomicBoolean isStopped)
void	setTracing(boolean isEnabled) Controls the low-level debug tracing.

Method Detail

readEncodedColumns

void readEncodedColumns(int stripeIx,
                        org.apache.orc.StripeInformation stripe,
                        org.apache.orc.OrcProto.RowIndex[] index,
                        List<org.apache.orc.OrcProto.ColumnEncoding> encodings,
                        List<org.apache.orc.OrcProto.Stream> streams,
                        boolean[] physicalFileIncludes,
                        boolean[] rgs,
                        Consumer<Reader.OrcEncodedColumnBatch> consumer)
                 throws IOException

Reads encoded data from ORC file.

Parameters:

stripeIx - Index of the stripe to read.

stripe - Externally provided metadata (from metadata reader or external cache).

index - Externally provided metadata (from metadata reader or external cache).

encodings - Externally provided metadata (from metadata reader or external cache).

streams - Externally provided metadata (from metadata reader or external cache).

physicalFileIncludes - The array of booleans indicating whether each column should be read.

rgs - Arrays of rgs, per column set to true in included, that are to be read. null in each respective position means all rgs for this column need to be read.

consumer - The sink for data that has been read.

Throws:

IOException

close

void close()
    throws IOException

Closes the reader.

Throws:

IOException

setTracing

void setTracing(boolean isEnabled)

Controls the low-level debug tracing. (Hopefully) allows for optimization where tracing checks are entirely eliminated because this method is called with constant value, similar to just checking the constant in the first place.

readIndexStreams

void readIndexStreams(org.apache.orc.impl.OrcIndex index,
                      org.apache.orc.StripeInformation stripe,
                      List<org.apache.orc.OrcProto.Stream> streams,
                      boolean[] included,
                      boolean[] sargColumns)
               throws IOException

Read the indexes from ORC file.

Parameters:

index - The destination with pre-allocated arrays to put index data into.

stripe - Externally provided metadata (from metadata reader or external cache).

streams - Externally provided metadata (from metadata reader or external cache).

included - The array of booleans indicating whether each column should be read.

sargColumns - The array of booleans indicating whether each column's bloom filters should be read.

Throws:

IOException

setStopped

void setStopped(AtomicBoolean isStopped)

preReadDataRanges

void preReadDataRanges(DiskRangeList ranges)
                throws IOException

Reads the encoded data from ORC file by disk ranges and populates the cache.

Throws:

IOException