Struct LogicalTableFunction 

pub struct LogicalTableFunction {
    pub base: PlanBase<Logical>,
    pub table_function: TableFunction,
    pub with_ordinality: bool,
}

LogicalTableFunction is a scalar/table function used as a relation (in the FROM clause).

If the function returns a struct, it will be flattened into multiple columns.

Fields

base: PlanBase<Logical>

table_function: TableFunction

with_ordinality: bool

Implementations

impl LogicalTableFunction

pub fn new( table_function: TableFunction, with_ordinality: bool, ctx: OptimizerContextRef, ) -> Self

Create a LogicalTableFunction node. Used internally by optimizer.

pub fn table_function(&self) -> &TableFunction

Methods from Deref<Target = PlanBase<Logical>>

pub fn clone_with_new_plan_id(&self) -> Self

pub fn clone_with_new_distribution(&self, dist: Distribution) -> Self

Clone the plan node with a new distribution.

Panics if the plan node is not physical.

Trait Implementations

impl Clone for LogicalTableFunction

fn clone(&self) -> LogicalTableFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ColPrunable for LogicalTableFunction

fn prune_col( &self, required_cols: &[usize], _ctx: &mut ColumnPruningContext, ) -> PlanRef

Transform the plan node to only output the required columns ordered by index number.

impl Debug for LogicalTableFunction

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

Formats the value using the given formatter.

impl Deref for LogicalTableFunction

type Target = PlanBase<Logical>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Distill for LogicalTableFunction

fn distill<'a>(&self) -> XmlNode<'a>

fn distill_to_string(&self) -> String

impl ExprRewritable<Logical> for LogicalTableFunction

fn has_rewritable_expr(&self) -> bool

fn rewrite_exprs(&self, r: &mut dyn ExprRewriter) -> PlanRef

impl ExprVisitable for LogicalTableFunction

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

impl Hash for LogicalTableFunction

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 LogicalTableFunction

fn eq(&self, other: &LogicalTableFunction) -> 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 PlanNodeMeta for LogicalTableFunction

const NODE_TYPE: LogicalPlanNodeType = LogicalPlanNodeType::LogicalTableFunction

type Convention = Logical

fn plan_base(&self) -> &PlanBase<Logical>

Get the reference to the PlanBase with corresponding convention.

impl PlanTreeNode<Logical> for LogicalTableFunction

fn clone_with_inputs(&self, inputs: &[PlanRef<Logical>]) -> PlanRef<Logical>

Clone the node with a list of new inputs.

fn inputs(&self) -> SmallVec<[PlanRef<Logical>; 2]>

Get input nodes of the plan.

impl PredicatePushdown for LogicalTableFunction

fn predicate_pushdown( &self, predicate: Condition, _ctx: &mut PredicatePushdownContext, ) -> PlanRef

Push predicate down for every logical plan node.

impl ToBatch for LogicalTableFunction

fn to_batch(&self) -> Result<BatchPlanRef>

to_batch is equivalent to to_batch_with_order_required(&Order::any())

fn to_batch_with_order_required( &self, required_order: &Order, ) -> Result<BatchPlanRef>

convert the plan to batch physical plan and satisfy the required Order

impl ToStream for LogicalTableFunction

fn to_stream(&self, _ctx: &mut ToStreamContext) -> Result<StreamPlanRef>

to_stream is equivalent to to_stream_with_dist_required(RequiredDist::Any)

fn logical_rewrite_for_stream( &self, _ctx: &mut RewriteStreamContext, ) -> Result<(PlanRef, ColIndexMapping)>

logical_rewrite_for_stream will rewrite the logical node, and return (new_plan_node, col_mapping), the col_mapping is for original columns have been changed into some other position.

fn to_stream_with_dist_required( &self, required_dist: &RequiredDist, ctx: &mut ToStreamContext, ) -> Result<StreamPlanRef>

convert the plan to streaming physical plan and satisfy the required distribution

fn try_better_locality(&self, _columns: &[usize]) -> Option<LogicalPlanRef>

impl Eq for LogicalTableFunction

impl LogicalPlanNode for LogicalTableFunction

impl StructuralPartialEq for LogicalTableFunction