Builder that produces a RestIncrementalAppendScan. More...
#include <rest_table_scan.h>
Inheritance diagram for iceberg::rest::RestIncrementalAppendScanBuilder:
Public Member Functions | |
| RestIncrementalAppendScanBuilder (std::shared_ptr< TableMetadata > metadata, std::shared_ptr< FileIO > io, std::string table_name, std::shared_ptr< MetricsReporter > metrics_reporter, std::shared_ptr< const RestScanContext > rest_context) | |
| Result< std::unique_ptr< IncrementalAppendScan > > | Build () override |
| Builds and returns a TableScan instance. | |
 Public Member Functions inherited from iceberg::TableScanBuilder< ScanType > | |
| TableScanBuilder & | Option (std::string key, std::string value) |
| Update property that will override the table's behavior based on the incoming pair. Unknown properties will be ignored. | |
| TableScanBuilder & | Project (std::shared_ptr< Schema > schema) |
| Set the projected schema. | |
| TableScanBuilder & | CaseSensitive (bool case_sensitive) |
| If data columns are selected via Select(), controls whether the match to the schema will be done with case sensitivity. Default is true. | |
| TableScanBuilder & | IncludeColumnStats () |
| Request this scan to load the column stats with each data file. | |
| TableScanBuilder & | IncludeColumnStats (const std::vector< std::string > &requested_columns) |
| Request this scan to load the column stats for the specific columns with each data file. | |
| TableScanBuilder & | Select (const std::vector< std::string > &column_names) |
| Request this scan to read the given data columns. | |
| TableScanBuilder & | Filter (std::shared_ptr< Expression > filter) |
| Set the expression to filter data. | |
| TableScanBuilder & | IgnoreResiduals () |
| Request data filtering to files but not to rows in those files. | |
| TableScanBuilder & | MinRowsRequested (int64_t num_rows) |
| Request this scan to return at least the given number of rows. | |
| TableScanBuilder & | PlanWith (Executor &executor) |
| Configure an executor for manifest planning. | |
| TableScanBuilder & | UseSnapshot (int64_t snapshot_id) |
| Request this scan to use the given snapshot by ID. | |
| TableScanBuilder & | UseRef (const std::string &ref) |
| Request this scan to use the given reference. | |
| TableScanBuilder & | AsOfTime (int64_t timestamp_millis) |
| Request this scan to use the most recent snapshot as of the given time in milliseconds on the branch in the scan or main if no branch is set. | |
| TableScanBuilder & | FromSnapshot (int64_t from_snapshot_id, bool inclusive=false) |
| Instructs this scan to look for changes starting from a particular snapshot. | |
| TableScanBuilder & | FromSnapshot (const std::string &ref, bool inclusive=false) |
| Instructs this scan to look for changes starting from a particular snapshot. | |
| TableScanBuilder & | ToSnapshot (int64_t to_snapshot_id) |
| Instructs this scan to look for changes up to a particular snapshot (inclusive). | |
| TableScanBuilder & | ToSnapshot (const std::string &ref) |
| Instructs this scan to look for changes up to a particular snapshot ref (inclusive). | |
| TableScanBuilder & | UseBranch (const std::string &branch) |
| Use the specified branch. | |
| TableScanBuilder & | ReportWith (std::shared_ptr< MetricsReporter > reporter) |
| Add a metrics reporter for this scan. | |
| Public Member Functions inherited from iceberg::ErrorCollector | |
| ErrorCollector (ErrorCollector &&)=default | |
| ErrorCollector & | operator= (ErrorCollector &&)=default |
| ErrorCollector (const ErrorCollector &)=default | |
| ErrorCollector & | operator= (const ErrorCollector &)=default |
| template<typename... Args> | |
| auto & | AddError (this auto &self, ErrorKind kind, const std::format_string< Args... > fmt, Args &&... args) |
| Add a specific error. | |
| auto & | AddError (this auto &self, Error err) |
| Add an existing error object. | |
| auto & | AddError (this auto &self, ::iceberg::unexpected< Error > err) |
| Add an unexpected result's error. | |
| auto & | AddError (this auto &self, std::unexpected< Error > err) |
| bool | has_errors () const |
| Check if any errors have been collected. | |
| size_t | error_count () const |
| Get the number of errors collected. | |
| Status | CheckErrors () const |
| Check for accumulated errors and return them if any exist. | |
| void | ClearErrors () |
| Clear all accumulated errors. | |
| const std::vector< Error > & | errors () const |
| Get read-only access to all collected errors. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from iceberg::TableScanBuilder< ScanType > | |
| static Result< std::unique_ptr< TableScanBuilder< ScanType > > > | Make (const Table &table) |
| Constructs a TableScanBuilder for the given table. | |
| Protected Member Functions inherited from iceberg::TableScanBuilder< ScanType > | |
| TableScanBuilder (std::shared_ptr< TableMetadata > metadata, std::shared_ptr< FileIO > io, std::string table_name, std::shared_ptr< MetricsReporter > metrics_reporter) | |
| TableScanBuilder (TableScanBuilder &&)=default | |
| TableScanBuilder & | operator= (TableScanBuilder &&)=default |
| Result< std::reference_wrapper< const std::shared_ptr< Schema > > > | ResolveSnapshotSchema () |
| Status | ResolveColumnStatsSelection () |
| Protected Attributes inherited from iceberg::TableScanBuilder< ScanType > | |
| std::shared_ptr< TableMetadata > | metadata_ |
| std::shared_ptr< FileIO > | io_ |
| internal::TableScanContext | context_ |
| std::shared_ptr< Schema > | snapshot_schema_ |
| std::optional< std::vector< std::string > > | requested_column_stats_ |
| Protected Attributes inherited from iceberg::ErrorCollector | |
| std::vector< Error > | errors_ |
Detailed Description
Builder that produces a RestIncrementalAppendScan.
Member Function Documentation
◆ Build()
|
overridevirtual |
Builds and returns a TableScan instance.
- Returns
- A Result containing the TableScan or an error.
Reimplemented from iceberg::TableScanBuilder< ScanType >.
The documentation for this class was generated from the following file:
- iceberg/catalog/rest/rest_table_scan.h
