Struct postgres_parser::nodes::GroupingFunc

pub struct GroupingFunc {
    pub args: Option<Vec<Node>>,
    pub refs: Option<Vec<Node>>,
    pub cols: Option<Vec<Node>>,
    pub agglevelsup: Index,
    pub location: i32,
}

GroupingFunc

A GroupingFunc is a GROUPING(...) expression, which behaves in many ways like an aggregate function (e.g. it "belongs" to a specific query level, which might not be the one immediately containing it), but also differs in an important respect: it never evaluates its arguments, they merely designate expressions from the GROUP BY clause of the query level to which it belongs.

The spec defines the evaluation of GROUPING() purely by syntactic replacement, but we make it a real expression for optimization purposes so that one Agg node can handle multiple grouping sets at once. Evaluating the result only needs the column positions to check against the grouping set being projected. However, for EXPLAIN to produce meaningful output, we have to keep the original expressions around, since expression deparse does not give us any feasible way to get at the GROUP BY clause.

Also, we treat two GroupingFunc nodes as equal if they have equal arguments lists and agglevelsup, without comparing the refs and cols annotations.

In raw parse output we have only the args list; parse analysis fills in the refs list, and the planner fills in the cols list.

Fields

args: Option<Vec<Node>>

refs: Option<Vec<Node>>

cols: Option<Vec<Node>>

agglevelsup: Index

location: i32

Trait Implementations

impl Debug for GroupingFunc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GroupingFunc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for GroupingFunc

impl PartialEq<GroupingFunc> for GroupingFunc

fn eq(&self, other: &GroupingFunc) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GroupingFunc) -> bool

This method tests for !=.

impl Serialize for GroupingFunc

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

Serialize this value into the given Serde serializer.

impl StructuralEq for GroupingFunc

impl StructuralPartialEq for GroupingFunc