Struct TableScan

pub struct TableScan {
    pub table_name: TableReference,
    pub source: Arc<dyn TableSource>,
    pub projection: Option<Vec<usize>>,
    pub projected_schema: Arc<DFSchema>,
    pub filters: Vec<Expr>,
    pub fetch: Option<usize>,
}

Produces rows from a table provider by reference or from the context

Fields

table_name: TableReference

The name of the table

source: Arc<dyn TableSource>

The source of the table

projection: Option<Vec<usize>>

Optional column indices to use as a projection

projected_schema: Arc<DFSchema>

The schema description of the output

filters: Vec<Expr>

Optional expressions to be used as filters by the table provider

fetch: Option<usize>

Optional number of rows to read

Implementations

impl TableScan

pub fn try_new( table_name: impl Into<TableReference>, table_source: Arc<dyn TableSource>, projection: Option<Vec<usize>>, filters: Vec<Expr>, fetch: Option<usize>, ) -> Result<TableScan, DataFusionError>

Initialize TableScan with appropriate schema from the given arguments.

Trait Implementations

impl Clone for TableScan

fn clone(&self) -> TableScan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableScan

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

Formats the value using the given formatter.

impl From<PyTableScan> for TableScan

fn from(tbl_scan: PyTableScan) -> TableScan

Converts to this type from the input type.

impl From<TableScan> for PyTableScan

fn from(table_scan: TableScan) -> PyTableScan

Converts to this type from the input type.

impl Hash for TableScan

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TableScan

fn eq(&self, other: &TableScan) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TableScan

fn partial_cmp(&self, other: &TableScan) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for TableScan