iceberg-cpp
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Friends | List of all members
iceberg::IncrementalScan< ScanTaskType > Class Template Referenceabstract

A base template class for incremental scans that read changes between snapshots, and return scan tasks of the specified type. More...

#include <table_scan.h>

Inheritance diagram for iceberg::IncrementalScan< ScanTaskType >:
iceberg::TableScan

Public Member Functions

virtual Result< std::vector< std::shared_ptr< ScanTaskType > > > PlanFiles () const =0
 
- Public Member Functions inherited from iceberg::TableScan
const std::shared_ptr< TableMetadata > & metadata () const
 Returns the table metadata being scanned.
 
Result< std::shared_ptr< Snapshot > > snapshot () const
 Returns the snapshot to scan. If there is no snapshot, returns nullptr.
 
Result< std::shared_ptr< Schema > > schema () const
 Returns the projected schema for the scan.
 
const internal::TableScanContextcontext () const
 Returns the scan context.
 
const std::shared_ptr< FileIO > & io () const
 Returns the file I/O instance used for reading files.
 
const std::shared_ptr< Expression > & filter () const
 Returns this scan's filter expression.
 
bool is_case_sensitive () const
 Returns whether this scan is case-sensitive.
 

Protected Member Functions

virtual Result< std::vector< std::shared_ptr< ScanTaskType > > > PlanFiles (std::optional< int64_t > from_snapshot_id_exclusive, int64_t to_snapshot_id_inclusive) const =0
 
 TableScan (std::shared_ptr< TableMetadata > metadata, std::shared_ptr< Schema > schema, std::shared_ptr< FileIO > io, internal::TableScanContext context)
 
- Protected Member Functions inherited from iceberg::TableScan
 TableScan (std::shared_ptr< TableMetadata > metadata, std::shared_ptr< Schema > schema, std::shared_ptr< FileIO > io, internal::TableScanContext context)
 
Result< std::reference_wrapper< const std::shared_ptr< Schema > > > ResolveProjectedSchema () const
 
virtual const std::vector< std::string > & ScanColumns () const
 

Friends

template<typename T >
Result< std::vector< std::shared_ptr< T > > > ResolvePlanFiles (const IncrementalScan< T > &scan)
 

Additional Inherited Members

- Protected Attributes inherited from iceberg::TableScan
const std::shared_ptr< TableMetadatametadata_
 
const std::shared_ptr< Schemaschema_
 
const std::shared_ptr< FileIOio_
 
const internal::TableScanContext context_
 
std::shared_ptr< Schemaprojected_schema_
 

Detailed Description

template<typename ScanTaskType>
class iceberg::IncrementalScan< ScanTaskType >

A base template class for incremental scans that read changes between snapshots, and return scan tasks of the specified type.


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