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

Class OrcFile

java.lang.Object

org.apache.orc.OrcFile

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

public final class OrcFile
extends org.apache.orc.OrcFile

Contains factory methods to read or write ORC files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OrcFile.ReaderOptions
static class	OrcFile.WriterOptions Options for creating ORC file writers.

Nested classes/interfaces inherited from class org.apache.orc.OrcFile

org.apache.orc.OrcFile.BloomFilterVersion, org.apache.orc.OrcFile.CompressionStrategy, org.apache.orc.OrcFile.EncodingStrategy, org.apache.orc.OrcFile.Version, org.apache.orc.OrcFile.WriterCallback, org.apache.orc.OrcFile.WriterContext, org.apache.orc.OrcFile.WriterImplementation, org.apache.orc.OrcFile.WriterVersion

Field Summary

Fields inherited from class org.apache.orc.OrcFile

CURRENT_WRITER, MAGIC

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OrcFile()

Method Summary

Modifier and Type	Method and Description
static Reader	createReader(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path) Create an ORC file reader.
static Reader	createReader(org.apache.hadoop.fs.Path path, OrcFile.ReaderOptions options)
static Writer	createWriter(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path, org.apache.hadoop.conf.Configuration conf, ObjectInspector inspector, long stripeSize, CompressionKind compress, int bufferSize, int rowIndexStride) Create an ORC file writer.
static Writer	createWriter(org.apache.hadoop.fs.Path path, OrcFile.WriterOptions opts) Create an ORC file writer.
static OrcFile.ReaderOptions	readerOptions(org.apache.hadoop.conf.Configuration conf)
static OrcFile.WriterOptions	writerOptions(org.apache.hadoop.conf.Configuration conf) Create a set of writer options based on a configuration.
static OrcFile.WriterOptions	writerOptions(Properties tableProperties, org.apache.hadoop.conf.Configuration conf) Create a set of write options based on a set of table properties and configuration.

Methods inherited from class org.apache.orc.OrcFile

mergeFiles

Methods inherited from class java.lang.Object

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

Constructor Detail

OrcFile

protected OrcFile()

Method Detail

createReader

public static Reader createReader(org.apache.hadoop.fs.FileSystem fs,
                                  org.apache.hadoop.fs.Path path)
                           throws IOException

Create an ORC file reader.

Parameters:

fs - file system

path - file name to read from

Returns:

a new ORC file reader.

Throws:

IOException

readerOptions

public static OrcFile.ReaderOptions readerOptions(org.apache.hadoop.conf.Configuration conf)

createReader

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

Throws:

IOException

writerOptions

public static OrcFile.WriterOptions writerOptions(org.apache.hadoop.conf.Configuration conf)

Create a set of writer options based on a configuration.

Parameters:

conf - the configuration to use for values

Returns:

A WriterOptions object that can be modified

writerOptions

public static OrcFile.WriterOptions writerOptions(Properties tableProperties,
                                                  org.apache.hadoop.conf.Configuration conf)

Create a set of write options based on a set of table properties and configuration.

Parameters:

tableProperties - the properties of the table

conf - the configuration of the query

Returns:

a WriterOptions object that can be modified

createWriter

public static Writer createWriter(org.apache.hadoop.fs.Path path,
                                  OrcFile.WriterOptions opts)
                           throws IOException

Create an ORC file writer. This is the public interface for creating writers going forward and new options will only be added to this method.

Parameters:

path - filename to write to

opts - the options

Returns:

a new ORC file writer

Throws:

IOException

createWriter

public static Writer createWriter(org.apache.hadoop.fs.FileSystem fs,
                                  org.apache.hadoop.fs.Path path,
                                  org.apache.hadoop.conf.Configuration conf,
                                  ObjectInspector inspector,
                                  long stripeSize,
                                  CompressionKind compress,
                                  int bufferSize,
                                  int rowIndexStride)
                           throws IOException

Create an ORC file writer. This method is provided for API backward compatability with Hive 0.11.

Parameters:

fs - file system

path - filename to write to

inspector - the ObjectInspector that inspects the rows

stripeSize - the number of bytes in a stripe

compress - how to compress the file

bufferSize - the number of bytes to compress at once

rowIndexStride - the number of rows between row index entries or 0 to suppress all indexes

Returns:

a new ORC file writer

Throws:

IOException