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

Task for static metadata tables (snapshots, history, refs). More...

#include <metadata_scan_task.h>

Inheritance diagram for iceberg::StaticMetadataTask:
iceberg::MetadataScanTask

Public Member Functions

TaskKind task_kind () const override
 Return how this task is read.
 
MetadataTableKind table_kind () const override
 Return the metadata table whose rows this task produces.
 
const std::shared_ptr< const TableMetadata > & metadata () const
 Return the captured metadata and its shared ownership.
 
const std::shared_ptr< Schema > & projected_schema () const
 Return the output schema captured when this task was planned.
 

Static Public Member Functions

static Result< std::shared_ptr< StaticMetadataTask > > Make (MetadataTableKind table_kind, std::shared_ptr< const TableMetadata > metadata, std::shared_ptr< Schema > projected_schema)
 Create a static metadata task.
 

Additional Inherited Members

- Public Types inherited from iceberg::MetadataScanTask
enum class  TaskKind { kStatic }
 Task category, determines how the reader opens the task. More...
 

Detailed Description

Task for static metadata tables (snapshots, history, refs).

Holds the metadata captured for a table scan; readers produce Arrow batches on demand. The metadata and its nested objects must not be modified while this task or its streams are in use.

Member Function Documentation

◆ Make()

static Result< std::shared_ptr< StaticMetadataTask > > iceberg::StaticMetadataTask::Make ( MetadataTableKind  table_kind,
std::shared_ptr< const TableMetadata >  metadata,
std::shared_ptr< Schema >  projected_schema 
)
static

Create a static metadata task.

Parameters
table_kindThe metadata table kind (kSnapshots, kHistory, or kRefs)
metadataThe table metadata to scan
projected_schemaThe planned output schema
Returns
A task, or an error for null metadata or an unsupported table kind.

◆ table_kind()

MetadataTableKind iceberg::StaticMetadataTask::table_kind ( ) const
inlineoverridevirtual

Return the metadata table whose rows this task produces.

Implements iceberg::MetadataScanTask.

◆ task_kind()

TaskKind iceberg::StaticMetadataTask::task_kind ( ) const
inlineoverridevirtual

Return how this task is read.

Implements iceberg::MetadataScanTask.


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