Reading and Writing ORC files — Apache Arrow v20.0.0 (original) (raw)

The Apache ORC project provides a standardized open-source columnar storage format for use in data analysis systems. It was created originally for use in Apache Hadoop with systems like Apache Drill, Apache Hive, Apache Impala, and Apache Spark adopting it as a shared standard for high performance data IO.

Apache Arrow is an ideal in-memory representation layer for data that is being read or written with ORC files.

Supported ORC features#

The ORC format has many features, and we support a subset of them.

Data types#

Here are a list of ORC types and mapped Arrow types.

• (1) On the read side the ORC type is read as the first corresponding Arrow type in the table.
• (2) On the write side the ORC TIMESTAMP_INSTANT is used when timezone is provided, otherwise ORC TIMESTAMP is used. On the read side both ORC TIMESTAMP and TIMESTAMP_INSTANT types are read as the Arrow Timestamp type with arrow::TimeUnit::NANO and timezone is set to UTC for ORC TIMESTAMP_INSTANT type only.
• (3) On the read side both ORC CHAR and VARCHAR types are read as the Arrow String type. ORC CHAR and VARCHAR types are not supported on the write side.

Compression#

Unsupported compression codec: LZO.

Reading ORC Files#

The ORCFileReader class reads data for an entire file or stripe into an ::arrow::Table.

ORCFileReader#

The ORCFileReader class requires a::arrow::io::RandomAccessFile instance representing the input file.

#include <arrow/adapters/orc/adapter.h>

{ // ... arrow::Status st; arrow::MemoryPool* pool = default_memory_pool(); std::shared_ptrarrow::io::RandomAccessFile input = ...;

// Open ORC file reader
auto maybe_reader = arrow::adapters::orc::ORCFileReader::Open(input, pool);
if (!maybe_reader.ok()) {
    // Handle error instantiating file reader...
}
std::unique_ptr<arrow::adapters::orc::ORCFileReader> reader = maybe_reader.ValueOrDie();

// Read entire file as a single Arrow table
auto maybe_table = reader->Read();
if (!maybe_table.ok()) {
    // Handle error reading ORC data...
}
std::shared_ptr<arrow::Table> table = maybe_table.ValueOrDie();

}

Writing ORC Files#

ORCFileWriter#

An ORC file is written to a OutputStream.

#include <arrow/adapters/orc/adapter.h> { // Oneshot write // ... std::shared_ptrarrow::io::OutputStream output = ...; auto writer_options = WriterOptions(); auto maybe_writer = arrow::adapters::orc::ORCFileWriter::Open(output.get(), writer_options); if (!maybe_writer.ok()) { // Handle error instantiating file writer... } std::unique_ptrarrow::adapters::orc::ORCFileWriter writer = maybe_writer.ValueOrDie(); if (!(writer->Write(*input_table)).ok()) { // Handle write error... } if (!(writer->Close()).ok()) { // Handle close error... } }