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

Refs metadata table. More...

#include <refs_table.h>

Inheritance diagram for iceberg::RefsTable:
iceberg::MetadataTable

Public Member Functions

MetadataTableKind kind () const noexcept override
 Return this metadata table's kind.
 
const std::shared_ptr< Schema > & schema () const override
 Return the complete canonical schema of this metadata table.
 
- Public Member Functions inherited from iceberg::MetadataTable
const std::shared_ptr< const Table > & source_table () const
 Return the source table whose metadata is exposed.
 
virtual Result< std::unique_ptr< MetadataScanBuilder > > NewScan () const
 Capture the source metadata and create a scan builder.
 

Static Public Member Functions

static Result< std::unique_ptr< RefsTable > > Make (std::shared_ptr< const Table > table)
 
static const std::shared_ptr< Schema > & CanonicalSchema ()
 Return the canonical schema of the refs metadata table.
 
- Static Public Member Functions inherited from iceberg::MetadataTable
static Result< std::unique_ptr< MetadataTable > > Make (std::shared_ptr< const Table > table, Kind kind)
 Create a metadata table; unsupported kinds return NotImplemented.
 
template<typename MetadataTableType >
requires std::derived_from<MetadataTableType, MetadataTable>
static Result< std::unique_ptr< MetadataTableType > > Make (std::shared_ptr< const Table > table)
 Create a specific metadata table from its concrete class.
 

Protected Member Functions

Result< std::unique_ptr< MetadataScan > > MakeScan (internal::MetadataScanContext context) const override
 Plan a scan using the captured metadata, projection, and snapshot selection.
 
- Protected Member Functions inherited from iceberg::MetadataTable
 MetadataTable (std::shared_ptr< const Table > source_table)
 

Friends

class MetadataScanTaskReader
 

Additional Inherited Members

- Public Types inherited from iceberg::MetadataTable
using Kind = MetadataTableKind
 

Detailed Description

Refs metadata table.

Member Function Documentation

◆ kind()

MetadataTableKind iceberg::RefsTable::kind ( ) const
inlineoverridevirtualnoexcept

Return this metadata table's kind.

Implements iceberg::MetadataTable.

◆ MakeScan()

Result< std::unique_ptr< MetadataScan > > iceberg::RefsTable::MakeScan ( internal::MetadataScanContext  context) const
overrideprotectedvirtual

Plan a scan using the captured metadata, projection, and snapshot selection.

Implements iceberg::MetadataTable.

◆ schema()

const std::shared_ptr< Schema > & iceberg::RefsTable::schema ( ) const
overridevirtual

Return the complete canonical schema of this metadata table.

Implements iceberg::MetadataTable.


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