Struct ScanArgs 

pub struct ScanArgs<'a> { /* private fields */ }

Arguments for scanning a table with TableProvider::scan_with_args.

Implementations

impl<'a> ScanArgs<'a>

pub fn with_projection(self, projection: Option<&'a [usize]>) -> ScanArgs<'a>

Set the column projection for the scan.

The projection is a list of column indices from TableProvider::schema that should be included in the scan results. If None, all columns are included.

Arguments

• projection - Optional slice of column indices to project

pub fn projection(&self) -> Option<&'a [usize]>

Get the column projection for the scan.

Returns a reference to the projection column indices, or None if no projection was specified (meaning all columns should be included).

pub fn with_filters(self, filters: Option<&'a [Expr]>) -> ScanArgs<'a>

Set the filter expressions for the scan.

Filters are boolean expressions that should be evaluated during the scan to reduce the number of rows returned. All expressions are combined with AND logic. Whether filters are actually pushed down depends on TableProvider::supports_filters_pushdown.

Arguments

• filters - Optional slice of filter expressions

pub fn filters(&self) -> Option<&'a [Expr]>

Get the filter expressions for the scan.

Returns a reference to the filter expressions, or None if no filters were specified.

pub fn with_limit(self, limit: Option<usize>) -> ScanArgs<'a>

Set the maximum number of rows to return from the scan.

If specified, the scan should return at most this many rows. This is typically used to optimize queries with LIMIT clauses.

Arguments

• limit - Optional maximum number of rows to return

pub fn limit(&self) -> Option<usize>

Get the maximum number of rows to return from the scan.

Returns the row limit, or None if no limit was specified.

Trait Implementations

impl<'a> Clone for ScanArgs<'a>

fn clone(&self) -> ScanArgs<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for ScanArgs<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> Default for ScanArgs<'a>

fn default() -> ScanArgs<'a>

Returns the “default value” for a type.