Enum mz_expr::relation::func::AggregateFunc

pub enum AggregateFunc {
    MaxNumeric,
    MaxInt16,
    MaxInt32,
    MaxInt64,
    MaxUInt16,
    MaxUInt32,
    MaxUInt64,
    MaxMzTimestamp,
    MaxFloat32,
    MaxFloat64,
    MaxBool,
    MaxString,
    MaxDate,
    MaxTimestamp,
    MaxTimestampTz,
    MaxInterval,
    MaxTime,
    MinNumeric,
    MinInt16,
    MinInt32,
    MinInt64,
    MinUInt16,
    MinUInt32,
    MinUInt64,
    MinMzTimestamp,
    MinFloat32,
    MinFloat64,
    MinBool,
    MinString,
    MinDate,
    MinTimestamp,
    MinTimestampTz,
    MinInterval,
    MinTime,
    SumInt16,
    SumInt32,
    SumInt64,
    SumUInt16,
    SumUInt32,
    SumUInt64,
    SumFloat32,
    SumFloat64,
    SumNumeric,
    Count,
    Any,
    All,
    JsonbAgg {
        order_by: Vec<ColumnOrder>,
    },
    JsonbObjectAgg {
        order_by: Vec<ColumnOrder>,
    },
    MapAgg {
        order_by: Vec<ColumnOrder>,
        value_type: ScalarType,
    },
    ArrayConcat {
        order_by: Vec<ColumnOrder>,
    },
    ListConcat {
        order_by: Vec<ColumnOrder>,
    },
    StringAgg {
        order_by: Vec<ColumnOrder>,
    },
    RowNumber {
        order_by: Vec<ColumnOrder>,
    },
    Rank {
        order_by: Vec<ColumnOrder>,
    },
    DenseRank {
        order_by: Vec<ColumnOrder>,
    },
    LagLead {
        order_by: Vec<ColumnOrder>,
        lag_lead: LagLeadType,
        ignore_nulls: bool,
    },
    FirstValue {
        order_by: Vec<ColumnOrder>,
        window_frame: WindowFrame,
    },
    LastValue {
        order_by: Vec<ColumnOrder>,
        window_frame: WindowFrame,
    },
    FusedValueWindowFunc {
        funcs: Vec<AggregateFunc>,
        order_by: Vec<ColumnOrder>,
    },
    WindowAggregate {
        wrapped_aggregate: Box<AggregateFunc>,
        order_by: Vec<ColumnOrder>,
        window_frame: WindowFrame,
    },
    FusedWindowAggregate {
        wrapped_aggregates: Vec<AggregateFunc>,
        order_by: Vec<ColumnOrder>,
        window_frame: WindowFrame,
    },
    Dummy,
}

Variants

MaxNumeric

MaxInt16

MaxInt32

MaxInt64

MaxUInt16

MaxUInt32

MaxUInt64

MaxMzTimestamp

MaxFloat32

MaxFloat64

MaxBool

MaxString

MaxDate

MaxTimestamp

MaxTimestampTz

MaxInterval

MaxTime

MinNumeric

MinInt16

MinInt32

MinInt64

MinUInt16

MinUInt32

MinUInt64

MinMzTimestamp

MinFloat32

MinFloat64

MinBool

MinString

MinDate

MinTimestamp

MinTimestampTz

MinInterval

MinTime

SumInt16

SumInt32

SumInt64

SumUInt16

SumUInt32

SumUInt64

SumFloat32

SumFloat64

SumNumeric

Count

Any

All

JsonbAgg

Accumulates Datum::Lists whose first element is a JSON-typed Datums into a JSON list. The other elements are columns used by order_by.

WARNING: Unlike the jsonb_agg function that is exposed by the SQL layer, this function filters out Datum::Null, for consistency with the other aggregate functions.

Fields

order_by: Vec<ColumnOrder>

JsonbObjectAgg

Zips Datum::Lists whose first element is a JSON-typed Datums into a JSON map. The other elements are columns used by order_by.

WARNING: Unlike the jsonb_object_agg function that is exposed by the SQL layer, this function filters out Datum::Null, for consistency with the other aggregate functions.

Fields

order_by: Vec<ColumnOrder>

MapAgg

Zips a Datum::List whose first element is a Datum::List guaranteed to be non-empty and whose len % 2 == 0 into a Datum::Map. The other elements are columns used by order_by.

Fields

order_by: Vec<ColumnOrder>

value_type: ScalarType

ArrayConcat

Accumulates Datum::Arrays of ScalarType::Record whose first element is a Datum::Array into a single Datum::Array (the remaining fields are used by order_by).

Fields

order_by: Vec<ColumnOrder>

ListConcat

Accumulates Datum::Lists of ScalarType::Record whose first field is a Datum::List into a single Datum::List (the remaining fields are used by order_by).

Fields

order_by: Vec<ColumnOrder>

StringAgg

Fields

order_by: Vec<ColumnOrder>

RowNumber

Fields

order_by: Vec<ColumnOrder>

Rank

Fields

order_by: Vec<ColumnOrder>

DenseRank

Fields

order_by: Vec<ColumnOrder>

LagLead

Fields

order_by: Vec<ColumnOrder>

lag_lead: LagLeadType

ignore_nulls: bool

FirstValue

Fields

order_by: Vec<ColumnOrder>

window_frame: WindowFrame

LastValue

Fields

order_by: Vec<ColumnOrder>

window_frame: WindowFrame

FusedValueWindowFunc

Several value window functions fused into one function, to amortize overheads.

Fields

funcs: Vec<AggregateFunc>

order_by: Vec<ColumnOrder>

Currently, all the fused functions must have the same order_by. (We can later eliminate this limitation.)

WindowAggregate

Fields

wrapped_aggregate: Box<AggregateFunc>

order_by: Vec<ColumnOrder>

window_frame: WindowFrame

FusedWindowAggregate

Fields

wrapped_aggregates: Vec<AggregateFunc>

order_by: Vec<ColumnOrder>

window_frame: WindowFrame

Dummy

Accumulates any number of Datum::Dummys into Datum::Dummy.

Useful for removing an expensive aggregation while maintaining the shape of a reduce operator.

Implementations

impl AggregateFunc

pub fn eval<'a, I>(&self, datums: I, temp_storage: &'a RowArena) -> Datum<'a>

where I: IntoIterator<Item = Datum<'a>>,

pub fn eval_with_fast_window_agg<'a, I, W>( &self, datums: I, temp_storage: &'a RowArena, ) -> Datum<'a>

where I: IntoIterator<Item = Datum<'a>>, W: OneByOneAggr,

Like eval, but it’s given a OneByOneAggr. If self is a WindowAggregate, then the given OneByOneAggr will be used to evaluate the wrapped aggregate inside the WindowAggregate. If self is not a WindowAggregate, then it simply calls eval.

pub fn eval_with_unnest_list<'a, I, W>( &self, datums: I, temp_storage: &'a RowArena, ) -> impl Iterator<Item = Datum<'a>>

where I: IntoIterator<Item = Datum<'a>>, W: OneByOneAggr,

pub fn default(&self) -> Datum<'static>

Returns the output of the aggregation function when applied on an empty input relation.

pub fn identity_datum(&self) -> Datum<'static>

Returns a datum whose inclusion in the aggregation will not change its result.

pub fn can_fuse_with_unnest_list(&self) -> bool

pub fn output_type(&self, input_type: ColumnType) -> ColumnType

The output column type for the result of an aggregation.

The output column type also contains nullability information, which is (without further information) true for aggregations that are not counts.

fn output_type_ranking_window_funcs( input_type: &ColumnType, col_name: &str, ) -> ScalarType

Compute output type for ROW_NUMBER, RANK, DENSE_RANK

fn lag_lead_output_type_inner_from_encoded_args( encoded_args_type: &ScalarType, ) -> ColumnType

Given the EncodedArgs part of ((OriginalRow, EncodedArgs), OrderByExprs...), this computes the type of the first field of the output type. (The first field is the real result, the rest is the original row.)

fn lag_lead_result_column_name(lag_lead_type: &LagLeadType) -> ColumnName

pub fn propagates_nonnull_constraint(&self) -> bool

Returns true if the non-null constraint on the aggregation can be converted into a non-null constraint on its parameter expression, ie. whether the result of the aggregation is null if all the input values are null.

impl AggregateFunc

pub fn name(&self) -> &'static str

The base function name without the ~[...] suffix used when rendering variants that represent a parameterized function family.

Trait Implementations

impl Arbitrary for AggregateFunc

An explicit Arbitrary implementation needed here because of a known proptest issue.

Revert to the derive-macro implementation once the issue¹ is fixed.

---

1. https://github.com/AltSysrq/proptest/issues/152 ↩

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Union<BoxedStrategy<AggregateFunc>>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for AggregateFunc

fn clone(&self) -> AggregateFunc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AggregateFunc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AggregateFunc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for AggregateFunc

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 MzReflect for AggregateFunc

fn add_to_reflected_type_info(rti: &mut ReflectedTypeInfo)

Adds names and types of the fields of the struct or enum to rti.

impl Ord for AggregateFunc

fn cmp(&self, other: &AggregateFunc) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for AggregateFunc

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

fn partial_cmp(&self, other: &AggregateFunc) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RustType<ProtoAggregateFunc> for AggregateFunc

fn into_proto(&self) -> ProtoAggregateFunc

Convert a Self into a Proto value.

fn from_proto(proto: ProtoAggregateFunc) -> Result<Self, TryFromProtoError>

Consume and convert a Proto back into a Self value.

fn into_proto_owned(self) -> Proto

A zero clone version of Self::into_proto that types can optionally implement, otherwise, the default implementation delegates to Self::into_proto.

impl Serialize for AggregateFunc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AggregateFunc

impl StructuralPartialEq for AggregateFunc