Enum Aggregate 

pub enum Aggregate {
    Count(Option<String>),
    Sum(String),
    Avg(String),
    Max(String),
    Min(String),
}

A SQL aggregate function over a single column (or * for COUNT).

Built via the named constructors on this type and passed to crate::orm::QuerySet::aggregate or crate::orm::QuerySet::annotate paired with an output name.

Variants

Count(Option<String>)

COUNT(*) when column is None, COUNT(col) when set (which skips NULLs in the named column).

Sum(String)

SUM(col) — NULL when no rows match.

Avg(String)

AVG(col) — always renders to a floating-point result type.

Max(String)

MAX(col) — same return type as the column.

Min(String)

MIN(col) — same return type as the column.

Implementations

impl Aggregate

pub fn count() -> Self

COUNT(*) — every row, including those with NULL columns.

pub fn count_col(name: impl Into<String>) -> Self

COUNT(col) — skips rows where col is NULL.

pub fn sum(name: impl Into<String>) -> Self

SUM(col).

pub fn avg(name: impl Into<String>) -> Self

AVG(col).

pub fn max(name: impl Into<String>) -> Self

MAX(col).

pub fn min(name: impl Into<String>) -> Self

MIN(col).

pub fn source_column(&self) -> Option<&str>

Source column for this aggregate, or None for COUNT(*). Used by the QuerySet terminals to validate against Model::FIELDS before running any SQL.

pub fn to_simple_expr(&self) -> SimpleExpr

Render to a sea_query::SimpleExpr for the SELECT list. Both backends accept the same function names for the supported set.

pub fn kind(&self) -> AggregateKind

One of "count", "sum", "avg", "max", "min" — used by the terminal to dispatch row-decoding (COUNT always returns i64, AVG always returns f64, SUM/MAX/MIN inherit the source column’s type).

Trait Implementations

impl Clone for Aggregate

fn clone(&self) -> Aggregate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Aggregate

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

Formats the value using the given formatter.