iceberg-cpp
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
iceberg::avro::AvroWriter Class Reference

A writer for serializing ArrowArray to Avro files. More...

#include <avro_writer.h>

Inheritance diagram for iceberg::avro::AvroWriter:
iceberg::Writer

Classes

class  Impl
 

Public Member Functions

Status Open (const WriterOptions &options) final
 Open the writer.
 
Status Close () final
 Close the writer.
 
Status Write (ArrowArray *data) final
 Write arrow data to the file.
 
Result< Metricsmetrics () final
 Get the file statistics. Only valid after the file is closed.
 
Result< int64_t > length () final
 Get the file length. This can be called while the writer is still open or after the file is closed.
 
std::vector< int64_t > split_offsets () final
 Returns a list of recommended split locations, if applicable, empty otherwise. When available, this information is used for planning scan tasks whose boundaries are determined by these offsets. The returned list must be sorted in ascending order. Only valid after the file is closed.
 
- Public Member Functions inherited from iceberg::Writer
 Writer (const Writer &)=delete
 
Writeroperator= (const Writer &)=delete
 

Detailed Description

A writer for serializing ArrowArray to Avro files.

Member Function Documentation

◆ Close()

Status iceberg::avro::AvroWriter::Close ( )
finalvirtual

Close the writer.

Implements iceberg::Writer.

◆ length()

Result< int64_t > iceberg::avro::AvroWriter::length ( )
finalvirtual

Get the file length. This can be called while the writer is still open or after the file is closed.

Implements iceberg::Writer.

◆ metrics()

Result< Metrics > iceberg::avro::AvroWriter::metrics ( )
finalvirtual

Get the file statistics. Only valid after the file is closed.

Implements iceberg::Writer.

◆ Open()

Status iceberg::avro::AvroWriter::Open ( const WriterOptions options)
finalvirtual

Open the writer.

Implements iceberg::Writer.

◆ split_offsets()

std::vector< int64_t > iceberg::avro::AvroWriter::split_offsets ( )
finalvirtual

Returns a list of recommended split locations, if applicable, empty otherwise. When available, this information is used for planning scan tasks whose boundaries are determined by these offsets. The returned list must be sorted in ascending order. Only valid after the file is closed.

Implements iceberg::Writer.

◆ Write()

Status iceberg::avro::AvroWriter::Write ( ArrowArray data)
finalvirtual

Write arrow data to the file.

Returns
Status of write results.
Note
Ownership of the data is transferred to the writer.

Implements iceberg::Writer.


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