Struct datafusion::physical_plan::windows::BoundedWindowAggExec

pub struct BoundedWindowAggExec {
    pub partition_keys: Vec<Arc<dyn PhysicalExpr>>,
    pub partition_search_mode: PartitionSearchMode,
    /* private fields */
}

Window execution plan

Fields

partition_keys: Vec<Arc<dyn PhysicalExpr>>

Partition Keys

partition_search_mode: PartitionSearchMode

Partition by search mode

Implementations

impl BoundedWindowAggExec

pub fn try_new( window_expr: Vec<Arc<dyn WindowExpr>>, input: Arc<dyn ExecutionPlan>, input_schema: SchemaRef, partition_keys: Vec<Arc<dyn PhysicalExpr>>, partition_search_mode: PartitionSearchMode ) -> Result<Self>

Create a new execution plan for window aggregates

pub fn window_expr(&self) -> &[Arc<dyn WindowExpr>]

Window expressions

pub fn input(&self) -> &Arc<dyn ExecutionPlan>

Input plan

pub fn input_schema(&self) -> SchemaRef

Get the input schema before any window functions are applied

pub fn partition_by_sort_keys(&self) -> Result<Vec<PhysicalSortExpr>>

Return the output sort order of partition keys: For example OVER(PARTITION BY a, ORDER BY b) -> would give sorting of the column a

Trait Implementations

impl Debug for BoundedWindowAggExec

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

Formats the value using the given formatter.

impl ExecutionPlan for BoundedWindowAggExec

fn as_any(&self) -> &dyn Any

Return a reference to Any that can be used for downcasting

fn output_partitioning(&self) -> Partitioning

Get the output partitioning of this plan

fn ordering_equivalence_properties(&self) -> OrderingEquivalenceProperties

Get the OrderingEquivalenceProperties within the plan

fn schema(&self) -> SchemaRef

Get the schema for this execution plan

fn children(&self) -> Vec<Arc<dyn ExecutionPlan>>

Get a list of child execution plans that provide the input for this plan. The returned list will be empty for leaf nodes, will contain a single value for unary nodes, or two values for binary nodes (such as joins).

fn unbounded_output(&self, children: &[bool]) -> Result<bool>

Specifies whether this plan generates an infinite stream of records. If the plan does not support pipelining, but its input(s) are infinite, returns an error to indicate this.

fn output_ordering(&self) -> Option<&[PhysicalSortExpr]>

If the output of this operator within each partition is sorted, returns Some(keys) with the description of how it was sorted.

fn required_input_ordering(&self) -> Vec<Option<Vec<PhysicalSortRequirement>>>

Specifies the ordering requirements for all of the children For each child, it’s the local ordering requirement within each partition rather than the global ordering

fn required_input_distribution(&self) -> Vec<Distribution>

Specifies the data distribution requirements for all the children for this operator, By default it’s [Distribution::UnspecifiedDistribution] for each child,

fn equivalence_properties(&self) -> EquivalenceProperties

Get the EquivalenceProperties within the plan

fn maintains_input_order(&self) -> Vec<bool>

Returns false if this operator’s implementation may reorder rows within or between partitions.

fn with_new_children( self: Arc<Self>, children: Vec<Arc<dyn ExecutionPlan>> ) -> Result<Arc<dyn ExecutionPlan>>

Returns a new plan where all children were replaced by new plans.

fn execute( &self, partition: usize, context: Arc<TaskContext> ) -> Result<SendableRecordBatchStream>

creates an iterator

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

Format this ExecutionPlan to f in the specified type.

fn metrics(&self) -> Option<MetricsSet>

Return a snapshot of the set of Metrics for this ExecutionPlan.

fn statistics(&self) -> Statistics

Returns the global output statistics for this ExecutionPlan node.

fn benefits_from_input_partitioning(&self) -> bool

Returns true if this operator would benefit from partitioning its input (and thus from more parallelism). For operators that do very little work the overhead of extra parallelism may outweigh any benefits