Struct Aggregate 

#[non_exhaustive]
pub struct Aggregate {
    pub func: AggregateFunc,
    pub field: Option<String>,
    pub alias: Option<String>,
}

An aggregation expression.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

func: AggregateFunc

The aggregation function to apply.

field: Option<String>

Field to aggregate, None for COUNT(*).

alias: Option<String>

Optional alias for the result.

Implementations

impl Aggregate

pub fn count() -> Self

Create a COUNT(*) aggregation.

pub fn count_field(field: impl Into<String>) -> Self

Create a COUNT(field) aggregation.

Panics

Panics if the field name is not a valid SQL identifier.

pub fn count_distinct(field: impl Into<String>) -> Self

Create a COUNT(DISTINCT field) aggregation.

Panics

Panics if the field name is not a valid SQL identifier.

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

Create a SUM(field) aggregation.

Panics

Panics if the field name is not a valid SQL identifier.

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

Create an AVG(field) aggregation.

Panics

Panics if the field name is not a valid SQL identifier.

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

Create a MIN(field) aggregation.

Panics

Panics if the field name is not a valid SQL identifier.

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

Create a MAX(field) aggregation.

Panics

Panics if the field name is not a valid SQL identifier.

pub fn as_alias(self, alias: impl Into<String>) -> Self

Set an alias for the aggregation result.

Panics

Panics if the alias is not a valid SQL identifier.

pub fn to_sql(&self) -> String

Generate SQL for this aggregation.

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.

impl PartialEq for Aggregate

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

impl StructuralPartialEq for Aggregate