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

java.lang.Object
  extended by org.apache.hadoop.hive.ql.io.orc.OrcFile

public final class OrcFile
extends Object

Contains factory methods to read or write ORC files.


Nested Class Summary
static class OrcFile.Version
          Create a version number for the ORC file format, so that we can add non-forward compatible changes in the future.
static class OrcFile.WriterOptions
          Options for creating ORC file writers.
 
Field Summary
static String BLOCK_PADDING
           
static String COMPRESSION
           
static String COMPRESSION_BLOCK_SIZE
           
static String ENABLE_INDEXES
           
static String MAGIC
           
static String ROW_INDEX_STRIDE
           
static String STRIPE_SIZE
           
 
Method Summary
static Reader createReader(FileSystem fs, Path path)
          Create an ORC file reader.
static Writer createWriter(FileSystem fs, Path path, Configuration conf, ObjectInspector inspector, long stripeSize, CompressionKind compress, int bufferSize, int rowIndexStride)
          Create an ORC file writer.
static Writer createWriter(Path path, OrcFile.WriterOptions opts)
          Create an ORC file writer.
static OrcFile.WriterOptions writerOptions(Configuration conf)
          Create a default set of write options that can be modified.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MAGIC

public static final String MAGIC
See Also:
Constant Field Values

COMPRESSION

public static final String COMPRESSION
See Also:
Constant Field Values

COMPRESSION_BLOCK_SIZE

public static final String COMPRESSION_BLOCK_SIZE
See Also:
Constant Field Values

STRIPE_SIZE

public static final String STRIPE_SIZE
See Also:
Constant Field Values

ROW_INDEX_STRIDE

public static final String ROW_INDEX_STRIDE
See Also:
Constant Field Values

ENABLE_INDEXES

public static final String ENABLE_INDEXES
See Also:
Constant Field Values

BLOCK_PADDING

public static final String BLOCK_PADDING
See Also:
Constant Field Values
Method Detail

createReader

public static Reader createReader(FileSystem 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

writerOptions

public static OrcFile.WriterOptions writerOptions(Configuration conf)
Create a default set of write options that can be modified.


createWriter

public static Writer createWriter(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
options - the options
Returns:
a new ORC file writer
Throws:
IOException

createWriter

public static Writer createWriter(FileSystem fs,
                                  Path path,
                                  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


Copyright © 2012 The Apache Software Foundation