Struct TableScanBuilder 

pub struct TableScanBuilder { /* private fields */ }

Builder for TableScan.

Prefer this over constructing a TableScan directly: it derives the projected_schema from the source schema and projection, and is resilient to new fields being added to TableScan. An existing scan can be turned back into a builder with TableScanBuilder::from(scan), tweaked, and rebuilt with TableScanBuilder::build.

Implementations

impl TableScanBuilder

pub fn new( table_name: impl Into<TableReference>, source: Arc<dyn TableSource>, ) -> Self

Create a new builder for a scan of source named table_name.

pub fn with_projection(self, projection: Option<Vec<usize>>) -> Self

Set the column projection (indices into the source schema).

pub fn with_filters(self, filters: Vec<Expr>) -> Self

Set the filter expressions offered to the table provider.

pub fn with_fetch(self, fetch: Option<usize>) -> Self

Set the maximum number of rows to read.

pub fn with_statistics_requests( self, statistics_requests: BTreeSet<StatisticsRequest>, ) -> Self

Set the statistics requests for the scan. See TableScan::statistics_requests.

pub fn build(self) -> Result<TableScan>

Build the TableScan, deriving its projected_schema from the source schema and projection.

Trait Implementations

impl From<TableScan> for TableScanBuilder

fn from(scan: TableScan) -> Self

Converts to this type from the input type.