Struct TableScan

pub struct TableScan {
    pub table_name: String,
    pub required_col_idx: Vec<usize>,
    pub output_col_idx: Vec<usize>,
    pub table_catalog: Arc<TableCatalog>,
    pub table_desc: Rc<TableDesc>,
    pub indexes: Vec<Rc<IndexCatalog>>,
    pub predicate: Condition,
    pub as_of: Option<AsOf>,
    pub table_cardinality: Cardinality,
    pub ctx: OptimizerContextRef,
}

TableScan returns contents of a RisingWave Table.

Fields

table_name: String

required_col_idx: Vec<usize>

Include output_col_idx and columns required in predicate

output_col_idx: Vec<usize>

table_catalog: Arc<TableCatalog>

Table Catalog of the upstream table that the descriptor is derived from.

table_desc: Rc<TableDesc>

Table Desc (subset of table catalog).

indexes: Vec<Rc<IndexCatalog>>

Descriptors of all indexes on this table

predicate: Condition

The pushed down predicates. It refers to column indexes of the table.

as_of: Option<AsOf>

syntax FOR SYSTEM_TIME AS OF PROCTIME() is used for temporal join. syntax FOR SYSTEM_TIME AS OF '1986-10-26 01:21:00' is used for iceberg. syntax FOR SYSTEM_TIME AS OF 499162860 is used for iceberg. syntax FOR SYSTEM_VERSION AS OF 10963874102873; is used for iceberg.

table_cardinality: Cardinality

The cardinality of the table without applying the predicate.

ctx: OptimizerContextRef

Implementations

impl TableScan

pub(crate) fn rewrite_exprs(&mut self, r: &mut dyn ExprRewriter)

pub(crate) fn visit_exprs(&self, v: &mut dyn ExprVisitor)

pub fn distribution_key(&self) -> Option<Vec<usize>>

The mapped distribution key of the scan operator.

The column indices in it is the position in the output_col_idx, instead of the position in all the columns of the table (which is the table’s distribution key).

Return None if the table’s distribution key are not all in the output_col_idx.

pub fn output_column_ids(&self) -> Vec<ColumnId>

Get the ids of the output columns.

pub fn primary_key(&self) -> &[ColumnOrder]

pub fn watermark_columns(&self) -> FixedBitSet

pub(crate) fn column_names_with_table_prefix(&self) -> Vec<String>

pub(crate) fn column_names(&self) -> Vec<String>

pub(crate) fn order_names(&self) -> Vec<String>

pub(crate) fn order_names_with_table_prefix(&self) -> Vec<String>

pub fn get_out_column_index_order(&self) -> Order

Return indices of fields the output is ordered by and corresponding direction

pub fn i2o_col_mapping(&self) -> ColIndexMapping

get the Mapping of columnIndex from internal column index to output column index

pub fn output_and_pk_column_ids(&self) -> Vec<ColumnId>

Get the ids of the output columns and primary key columns.

pub fn to_index_scan( &self, index_name: &str, index_table_catalog: Arc<TableCatalog>, primary_to_secondary_mapping: &BTreeMap<usize, usize>, function_mapping: &HashMap<FunctionCall, usize>, ) -> Self

Prerequisite: the caller should guarantee that primary_to_secondary_mapping must cover the scan.

pub(crate) fn new( table_name: String, output_col_idx: Vec<usize>, table_catalog: Arc<TableCatalog>, indexes: Vec<Rc<IndexCatalog>>, ctx: OptimizerContextRef, predicate: Condition, as_of: Option<AsOf>, table_cardinality: Cardinality, ) -> Self

Create a LogicalScan node. Used internally by optimizer.

pub(crate) fn new_inner( table_name: String, output_col_idx: Vec<usize>, table_catalog: Arc<TableCatalog>, indexes: Vec<Rc<IndexCatalog>>, ctx: OptimizerContextRef, predicate: Condition, as_of: Option<AsOf>, table_cardinality: Cardinality, ) -> Self

pub(crate) fn columns_pretty<'a>(&self, verbose: bool) -> Pretty<'a>

pub(crate) fn fields_pretty_schema(&self) -> Schema

impl TableScan

pub fn get_table_columns(&self) -> &[ColumnDesc]

pub fn append_only(&self) -> bool

pub fn column_descs(&self) -> Vec<ColumnDesc>

Get the descs of the output columns.

pub fn get_id_to_op_idx_mapping( output_col_idx: &[usize], table_desc: &Rc<TableDesc>, ) -> HashMap<ColumnId, usize>

Helper function to create a mapping from column_id to operator_idx

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

Formats the value using the given formatter.

impl From<TableScan> for LogicalScan

fn from(core: TableScan) -> Self

Converts to this type from the input type.

impl From<TableScan> for PlanRef

fn from(core: TableScan) -> Self

Converts to this type from the input type.

impl GenericPlanNode for TableScan

fn schema(&self) -> Schema

fn stream_key(&self) -> Option<Vec<usize>>

fn ctx(&self) -> OptimizerContextRef

fn functional_dependency(&self) -> FunctionalDependencySet

impl Hash for TableScan

where String: Hash, Vec<usize>: Hash, Arc<TableCatalog>: Hash, Rc<TableDesc>: Hash, Vec<Rc<IndexCatalog>>: Hash, Condition: Hash, Option<AsOf>: Hash, Cardinality: Hash,

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

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

where String: PartialEq, Vec<usize>: PartialEq, Arc<TableCatalog>: PartialEq, Rc<TableDesc>: PartialEq, Vec<Rc<IndexCatalog>>: PartialEq, Condition: PartialEq, Option<AsOf>: PartialEq, Cardinality: PartialEq,

fn eq(&self, other: &Self) -> 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 Eq for TableScan

where String: PartialEq, Vec<usize>: PartialEq, Arc<TableCatalog>: PartialEq, Rc<TableDesc>: PartialEq, Vec<Rc<IndexCatalog>>: PartialEq, Condition: PartialEq, Option<AsOf>: PartialEq, Cardinality: PartialEq,