Struct Scan 

pub struct Scan {
    pub batch_rows: Option<u32>,
    pub collect_metrics: Option<bool>,
    pub columns: Option<Vec<String>>,
    pub emit: Option<Emit>,
    pub execution: Option<ExecutionOptions>,
    pub filter: Option<Expression>,
    pub limit: Option<SafeUnsignedLong>,
    pub projection: Option<Vec<NamedExpression>>,
    pub row_id_column: Option<String>,
    pub row_ids: Option<Vec<RowIdRange>>,
    pub row_range: Option<RowRange>,
    pub table: TableVersion,
}

A read of one Table version, sent whole with every plan and read request. columns selects top-level columns, or all of them when absent; projection computes the output columns instead. A filter clause that the service cannot enforce exactly fails the scan before any rows are read. limit caps the rows each split returns, in stored order. An emit returns a top-k or aggregates of the output rows instead of the rows themselves. rowRange selects half-open stored positions in this exact version, before filtering and deletion removal, concatenating fragments in stored order. Positions are not stable across rewrites. Empty ranges return no rows; reversed ranges are invalid. rowIdColumn adds a last output column of that name holding each row’s row ID: the Table’s stable identity of the row, a uint64 that survives rewrites and compaction and is never reused. rowIds keeps only rows whose row IDs fall in its ranges: planning prunes files whose row IDs cannot match, and reads enforce it exactly. A top-k can return and order by the row ID column. Aggregates take no rowIdColumn.

Fields

batch_rows: Option<u32>

Contract field batchRows.

collect_metrics: Option<bool>

Contract field collectMetrics.

columns: Option<Vec<String>>

Contract field columns.

emit: Option<Emit>

Contract field emit.

execution: Option<ExecutionOptions>

Contract field execution.

filter: Option<Expression>

Contract field filter.

limit: Option<SafeUnsignedLong>

Contract field limit.

projection: Option<Vec<NamedExpression>>

Contract field projection.

row_id_column: Option<String>

Contract field rowIdColumn.

row_ids: Option<Vec<RowIdRange>>

Contract field rowIds.

row_range: Option<RowRange>

Contract field rowRange.

table: TableVersion

Contract field table.

Implementations

impl Scan

pub fn new(table: TableVersion) -> Self

Read every column of table without a filter or limit.

pub fn collects_metrics(&self) -> bool

Whether the scan reports execution counters.

Trait Implementations

impl Clone for Scan

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Scan

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Scan

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de> DeserializeStrict<'de> for Scan

fn deserialize_strict<D: Deserializer<'de>>( deserializer: D, ) -> Result<Self, D::Error>

Deserialize a request value, including strict decoding of its children.

impl PartialEq for Scan

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Scan

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Scan