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

Class ReaderImpl

java.lang.Object

org.apache.orc.impl.ReaderImpl

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

All Implemented Interfaces:

org.apache.orc.Reader

public class ReaderImpl
extends org.apache.orc.impl.ReaderImpl
implements Reader

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.orc.impl.ReaderImpl

org.apache.orc.impl.ReaderImpl.StripeInformationImpl

Nested classes/interfaces inherited from interface org.apache.orc.Reader

org.apache.orc.Reader.Options

Field Summary

Fields inherited from class org.apache.orc.impl.ReaderImpl

bufferSize, compressionKind, conf, fileSystem, metadata, path, rowIndexStride, tail, types, useUTCTimestamp

Constructor Summary

Constructors

Constructor and Description
ReaderImpl(org.apache.hadoop.fs.Path path, OrcFile.ReaderOptions options) Constructor that let's the user specify additional options.

Method Summary

Modifier and Type	Method and Description
CompressionKind	getCompression() Get the Compression kind in the compatibility mode.
ObjectInspector	getObjectInspector() Get the object inspector for looking at the objects.
ByteBuffer	getSerializedFileFooter()
RecordReader	rows() Create a RecordReader that reads everything with the default options.
RecordReader	rows(boolean[] include) Create a RecordReader that will scan the entire file.
RecordReader	rows(long offset, long length, boolean[] include) Create a RecordReader that will start reading at the first stripe after offset up to the stripe that starts at offset + length.
RecordReader	rows(long offset, long length, boolean[] include, org.apache.hadoop.hive.ql.io.sarg.SearchArgument sarg, String[] columnNames) Create a RecordReader that will read a section of a file.
RecordReader	rowsOptions(org.apache.orc.Reader.Options options) Create a RecordReader that reads everything with the given options.
RecordReader	rowsOptions(org.apache.orc.Reader.Options options, org.apache.hadoop.conf.Configuration conf) Create a RecordReader that reads everything with the given options.
String	toString()

Methods inherited from class org.apache.orc.impl.ReaderImpl

checkOrcVersion, deserializeStats, ensureOrcFooter, ensureOrcFooter, extractFileTail, extractFileTail, extractFileTail, extractMetadata, getCompressionKind, getCompressionSize, getContentLength, getFileTail, getFileVersion, getFileVersion, getMetadataKeys, getMetadataSize, getMetadataValue, getNumberOfRows, getOrcProtoFileStatistics, getOrcProtoStripeStatistics, getOrcProtoUserMetadata, getRawDataSize, getRawDataSizeFromColIndices, getRawDataSizeFromColIndices, getRawDataSizeOfColumns, getRowIndexStride, getSchema, getStatistics, getStripes, getStripeStatistics, getTypes, getVersionList, getWriterVersion, getWriterVersion, hasMetadataValue, options, rows

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.orc.Reader

getCompressionKind, getCompressionSize, getContentLength, getFileTail, getFileVersion, getMetadataKeys, getMetadataSize, getMetadataValue, getNumberOfRows, getOrcProtoFileStatistics, getOrcProtoStripeStatistics, getRawDataSize, getRawDataSizeFromColIndices, getRawDataSizeOfColumns, getRowIndexStride, getSchema, getStatistics, getStripes, getStripeStatistics, getTypes, getVersionList, getWriterVersion, hasMetadataValue, options, rows

Constructor Detail

ReaderImpl

public ReaderImpl(org.apache.hadoop.fs.Path path,
                  OrcFile.ReaderOptions options)
           throws IOException

Constructor that let's the user specify additional options.

Parameters:

path - pathname for file

options - options for reading

Throws:

IOException

Method Detail

getObjectInspector

public ObjectInspector getObjectInspector()

Description copied from interface: Reader

Get the object inspector for looking at the objects.

Returns:

an object inspector for each row returned

getCompression

public CompressionKind getCompression()

Description copied from interface: Reader

Get the Compression kind in the compatibility mode.

getSerializedFileFooter

public ByteBuffer getSerializedFileFooter()

Specified by:

getSerializedFileFooter in interface org.apache.orc.Reader

Overrides:

getSerializedFileFooter in class org.apache.orc.impl.ReaderImpl

rows

public RecordReader rows()
                  throws IOException

Description copied from interface: Reader

Create a RecordReader that reads everything with the default options.

Specified by:

rows in interface org.apache.orc.Reader

Overrides:

rows in class org.apache.orc.impl.ReaderImpl

Returns:

a new RecordReader

Throws:

IOException

rowsOptions

public RecordReader rowsOptions(org.apache.orc.Reader.Options options)
                         throws IOException

Description copied from interface: Reader

Create a RecordReader that reads everything with the given options.

Parameters:

options - the options to use

Returns:

a new RecordReader

Throws:

IOException

rowsOptions

public RecordReader rowsOptions(org.apache.orc.Reader.Options options,
                                org.apache.hadoop.conf.Configuration conf)
                         throws IOException

Description copied from interface: Reader

Create a RecordReader that reads everything with the given options.

Parameters:

options - the options to use

conf - conf object

Returns:

a new RecordReader

Throws:

IOException

rows

public RecordReader rows(boolean[] include)
                  throws IOException

Description copied from interface: Reader

Create a RecordReader that will scan the entire file. This is a legacy method and rowsOptions is preferred.

Parameters:

include - true for each column that should be included

Returns:

A new RecordReader

Throws:

IOException

rows

public RecordReader rows(long offset,
                         long length,
                         boolean[] include)
                  throws IOException

Description copied from interface: Reader

Create a RecordReader that will start reading at the first stripe after offset up to the stripe that starts at offset + length. This is intended to work with MapReduce's FileInputFormat where divisions are picked blindly, but they must cover all of the rows. This is a legacy method and rowsOptions is preferred.

Parameters:

offset - a byte offset in the file

length - a number of bytes in the file

include - true for each column that should be included

Returns:

a new RecordReader that will read the specified rows.

Throws:

IOException

rows

public RecordReader rows(long offset,
                         long length,
                         boolean[] include,
                         org.apache.hadoop.hive.ql.io.sarg.SearchArgument sarg,
                         String[] columnNames)
                  throws IOException

Description copied from interface: Reader

Create a RecordReader that will read a section of a file. It starts reading at the first stripe after the offset and continues to the stripe that starts at offset + length. It also accepts a list of columns to read and a search argument. This is a legacy method and rowsOptions is preferred.

Parameters:

offset - the minimum offset of the first stripe to read

length - the distance from offset of the first address to stop reading at

include - true for each column that should be included

sarg - a search argument that limits the rows that should be read.

columnNames - the names of the included columns

Returns:

the record reader for the rows

Throws:

IOException

toString

public String toString()

Overrides:

toString in class org.apache.orc.impl.ReaderImpl