Struct PlanBase 

pub struct PlanBase<C: ConventionMarker> {
    id: PlanNodeId,
    ctx: OptimizerContextRef,
    schema: Schema,
    stream_key: Option<Vec<usize>>,
    functional_dependency: FunctionalDependencySet,
    extra: C::Extra,
}

The common fields of all plan nodes with different conventions.

Please make a field named base in every planNode and correctly value it when construct the planNode.

All fields are intentionally made private and immutable, as they should normally be the same as the given GenericPlanNode when constructing.

• To access them, use traits including GenericPlanRef, PhysicalPlanRef, StreamPlanNodeMetadata and BatchPlanNodeMetadata with compile-time checks.
• To mutate them, use methods like new_* or clone_with_*.

Fields

id: PlanNodeId

ctx: OptimizerContextRef

schema: Schema

stream_key: Option<Vec<usize>>

the pk indices of the PlanNode’s output, a empty stream key vec means there is no stream key

functional_dependency: FunctionalDependencySet

extra: C::Extra

Extra fields for different conventions.

Implementations

impl<C: ConventionMarker> PlanBase<C>

pub fn clone_with_new_plan_id(&self) -> Self

impl PlanBase<Logical>

pub fn new_logical( ctx: OptimizerContextRef, schema: Schema, stream_key: Option<Vec<usize>>, functional_dependency: FunctionalDependencySet, ) -> Self

pub fn new_logical_with_core(core: &impl GenericPlanNode) -> Self

impl PlanBase<Stream>

pub fn new_stream( ctx: OptimizerContextRef, schema: Schema, stream_key: Option<Vec<usize>>, functional_dependency: FunctionalDependencySet, dist: Distribution, stream_kind: StreamKind, emit_on_window_close: bool, watermark_columns: WatermarkColumns, columns_monotonicity: MonotonicityMap, ) -> Self

pub fn new_stream_with_core( core: &impl GenericPlanNode, dist: Distribution, stream_kind: StreamKind, emit_on_window_close: bool, watermark_columns: WatermarkColumns, columns_monotonicity: MonotonicityMap, ) -> Self

impl PlanBase<Batch>

pub fn new_batch( ctx: OptimizerContextRef, schema: Schema, dist: Distribution, order: Order, ) -> Self

pub fn new_batch_with_core( core: &impl GenericPlanNode, dist: Distribution, order: Order, ) -> Self

impl<C: ConventionMarker> PlanBase<C>

where C::Extra: GetPhysicalCommon,

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 BatchPlanNodeMetadata for PlanBase<Batch>

fn order(&self) -> &Order

impl<C: ConventionMarker> Clone for PlanBase<C>

where PlanNodeId: Clone, OptimizerContextRef: Clone, Schema: Clone, Option<Vec<usize>>: Clone, FunctionalDependencySet: Clone, C::Extra: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: ConventionMarker> Debug for PlanBase<C>

where PlanNodeId: Debug, OptimizerContextRef: Debug, Schema: Debug, Option<Vec<usize>>: Debug, FunctionalDependencySet: Debug, C::Extra: Debug,

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

Formats the value using the given formatter.

impl<C: ConventionMarker> GenericPlanRef for PlanBase<C>

fn id(&self) -> PlanNodeId

fn schema(&self) -> &Schema

fn stream_key(&self) -> Option<&[usize]>

fn ctx(&self) -> OptimizerContextRef

fn functional_dependency(&self) -> &FunctionalDependencySet

impl<C: ConventionMarker> Hash for PlanBase<C>

where Schema: Hash, Option<Vec<usize>>: Hash, FunctionalDependencySet: Hash, C::Extra: 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<C: ConventionMarker> PartialEq for PlanBase<C>

where Schema: PartialEq, Option<Vec<usize>>: PartialEq, FunctionalDependencySet: PartialEq, C::Extra: 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<C: ConventionMarker> PhysicalPlanRef for PlanBase<C>

where C::Extra: GetPhysicalCommon,

fn distribution(&self) -> &Distribution

impl StreamPlanNodeMetadata for PlanBase<Stream>

fn stream_kind(&self) -> StreamKind

fn emit_on_window_close(&self) -> bool

fn watermark_columns(&self) -> &WatermarkColumns

fn columns_monotonicity(&self) -> &MonotonicityMap

fn append_only(&self) -> bool

impl<C: ConventionMarker> Eq for PlanBase<C>

where Schema: PartialEq, Option<Vec<usize>>: PartialEq, FunctionalDependencySet: PartialEq, C::Extra: PartialEq,