iceberg::FileWriter Class Reference

Base interface for data file writers. More...

#include <writer.h>

Inheritance diagram for iceberg::FileWriter:

Classes
struct	WriteResult
	File metadata for all files produced by this writer. More...

Public Member Functions
virtual Status	Write (ArrowArray *data)=0
	Write a batch of records.
virtual Result< int64_t >	Length () const =0
	Get the current number of bytes written.
virtual Status	Close ()=0
	Close the writer and finalize the file.
virtual Result< WriteResult >	Metadata ()=0
	Get file metadata for all files produced by this writer.

Detailed Description

Base interface for data file writers.

Member Function Documentation

Close()

virtual Status iceberg::FileWriter::Close ( )

pure virtual

Close the writer and finalize the file.

Implemented in iceberg::DataWriter, iceberg::EqualityDeleteWriter, and iceberg::PositionDeleteWriter.

Length()

virtual Result< int64_t > iceberg::FileWriter::Length ( ) const

pure virtual

Get the current number of bytes written.

Implemented in iceberg::DataWriter, iceberg::EqualityDeleteWriter, and iceberg::PositionDeleteWriter.

Metadata()

virtual Result< WriteResult > iceberg::FileWriter::Metadata ( )

pure virtual

Get file metadata for all files produced by this writer.

Note

This method should be called after Close().

Implemented in iceberg::DataWriter, iceberg::EqualityDeleteWriter, and iceberg::PositionDeleteWriter.

Write()

virtual Status iceberg::FileWriter::Write ( ArrowArray *  data )

pure virtual

Write a batch of records.

Note

The ownership of the ArrowArray will be transferred to the writer.

Implemented in iceberg::DataWriter, iceberg::EqualityDeleteWriter, and iceberg::PositionDeleteWriter.

---

The documentation for this class was generated from the following files:

• iceberg/data/writer.h
• iceberg/data/writer.cc