iceberg-cpp
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
iceberg::puffin::PuffinWriter Class Reference

Writer for Puffin files. More...

#include <puffin_writer.h>

Public Member Functions

Result< BlobMetadataWrite (const Blob &blob)
 Write a blob and return its metadata.
 
Status Finish ()
 Finalize the file by writing the footer and closing the stream.
 
Status Close ()
 Close the writer, finalizing the file if needed.
 
const std::vector< BlobMetadata > & written_blobs_metadata () const
 Get metadata for all blobs written so far.
 
Result< int64_t > FooterSize () const
 Get the footer size. Returns error if the footer has not been written.
 
Result< int64_t > FileSize () const
 Get the total file size. Returns error if Finish() has not succeeded.
 

Static Public Member Functions

static Result< std::unique_ptr< PuffinWriter > > Make (std::unique_ptr< OutputFile > output_file, std::unordered_map< std::string, std::string > properties={}, PuffinCompressionCodec default_codec=PuffinCompressionCodec::kNone, bool compress_footer=false)
 Create a PuffinWriter for the given output file.
 

Detailed Description

Writer for Puffin files.

Writes blobs and footer to an OutputFile stream.

Member Function Documentation

◆ Make()

Result< std::unique_ptr< PuffinWriter > > iceberg::puffin::PuffinWriter::Make ( std::unique_ptr< OutputFile output_file,
std::unordered_map< std::string, std::string >  properties = {},
PuffinCompressionCodec  default_codec = PuffinCompressionCodec::kNone,
bool  compress_footer = false 
)
static

Create a PuffinWriter for the given output file.

Parameters
output_fileThe output file to write to.
propertiesFile-level properties to include in the footer.
default_codecDefault compression codec for blobs.
compress_footerWhether to compress the footer payload.

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