Struct datafusion::physical_plan::windows::AggregateWindowExpr

pub struct AggregateWindowExpr { /* private fields */ }

A window expr that takes the form of an aggregate function

Implementations

impl AggregateWindowExpr

pub fn new(
    aggregate: Arc<dyn AggregateExpr + 'static>,
    partition_by: &[Arc<dyn PhysicalExpr + 'static>],
    order_by: &[PhysicalSortExpr],
    window_frame: Arc<WindowFrame>
) -> AggregateWindowExpr

create a new aggregate window function expression

pub fn get_aggregate_expr(&self) -> &Arc<dyn AggregateExpr + 'static>

Get aggregate expr of AggregateWindowExpr

Trait Implementations

impl Debug for AggregateWindowExpr

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

Formats the value using the given formatter.

impl WindowExpr for AggregateWindowExpr

peer based evaluation based on the fact that batch is pre-sorted given the sort columns and then per partition point we’ll evaluate the peer group (e.g. SUM or MAX gives the same results for peers) and concatenate the results.

fn as_any(&self) -> &(dyn Any + 'static)

Return a reference to Any that can be used for downcasting

fn field(&self) -> Result<Field, DataFusionError>

the field of the final result of this window function.

fn name(&self) -> &str

Human readable name such as "MIN(c2)" or "RANK()". The default implementation returns placeholder text.

fn expressions(&self) -> Vec<Arc<dyn PhysicalExpr + 'static>, Global>

expressions that are passed to the WindowAccumulator. Functions which take a single input argument, such as sum, return a single datafusion_expr::expr::Expr, others (e.g. cov) return many.

fn evaluate(
    &self,
    batch: &RecordBatch
) -> Result<Arc<dyn Array + 'static>, DataFusionError>

evaluate the window function values against the batch

fn partition_by(&self) -> &[Arc<dyn PhysicalExpr + 'static>]

expressions that’s from the window function’s partition by clause, empty if absent

fn order_by(&self) -> &[PhysicalSortExpr]

expressions that’s from the window function’s order by clause, empty if absent

fn get_window_frame(&self) -> &Arc<WindowFrame>

Get the window frame of this WindowExpr.

fn get_reverse_expr(&self) -> Option<Arc<dyn WindowExpr + 'static>>

Get the reverse expression of this WindowExpr.

fn uses_bounded_memory(&self) -> bool

Return a flag indicating whether this WindowExpr can run with bounded memory.

fn evaluate_args(
    &self,
    batch: &RecordBatch
) -> Result<Vec<Arc<dyn Array + 'static>, Global>, DataFusionError>

evaluate the window function arguments against the batch and return array ref, normally the resulting vec is a single element one.

fn evaluate_stateful(
    &self,
    _partition_batches: &IndexMap<Vec<ScalarValue, Global>, PartitionBatchState, RandomState>,
    _window_agg_state: &mut IndexMap<Vec<ScalarValue, Global>, WindowState, RandomState>
) -> Result<(), DataFusionError>

evaluate the window function values against the batch

fn evaluate_partition_points(
    &self,
    num_rows: usize,
    partition_columns: &[SortColumn]
) -> Result<Vec<Range<usize>, Global>, DataFusionError>

evaluate the partition points given the sort columns; if the sort columns are empty then the result will be a single element vec of the whole column rows.

fn order_by_columns(
    &self,
    batch: &RecordBatch
) -> Result<Vec<SortColumn, Global>, DataFusionError>

get order by columns, empty if absent

fn sort_columns(
    &self,
    batch: &RecordBatch
) -> Result<Vec<SortColumn, Global>, DataFusionError>

get sort columns that can be used for peer evaluation, empty if absent

fn get_values_orderbys(
    &self,
    record_batch: &RecordBatch
) -> Result<(Vec<Arc<dyn Array + 'static>, Global>, Vec<Arc<dyn Array + 'static>, Global>), DataFusionError>

Get values columns(argument of Window Function) and order by columns (columns of the ORDER BY expression)used in evaluators