Struct Function

pub struct Function {
    pub name: ObjectName,
    pub uses_odbc_syntax: bool,
    pub parameters: FunctionArguments,
    pub args: FunctionArguments,
    pub filter: Option<Box<Expr>>,
    pub null_treatment: Option<NullTreatment>,
    pub over: Option<WindowType>,
    pub within_group: Vec<OrderByExpr>,
}

A function call

Fields

name: ObjectName

uses_odbc_syntax: bool

Flags whether this function call uses the ODBC syntax.

Example:

SELECT {fn CONCAT('foo', 'bar')}

parameters: FunctionArguments

The parameters to the function, including any options specified within the delimiting parentheses.

Example:

HISTOGRAM(0.5, 0.6)(x, y)

ClickHouse

args: FunctionArguments

The arguments to the function, including any options specified within the delimiting parentheses.

filter: Option<Box<Expr>>

e.g. x > 5 in COUNT(x) FILTER (WHERE x > 5)

null_treatment: Option<NullTreatment>

Indicates how NULLs should be handled in the calculation.

Example:

FIRST_VALUE( <expr> ) [ { IGNORE | RESPECT } NULLS ] OVER ...

Snowflake

over: Option<WindowType>

The OVER clause, indicating a window function call.

within_group: Vec<OrderByExpr>

A clause used with certain aggregate functions to control the ordering within grouped sets before the function is applied.

Syntax:

<aggregate_function>(expression) WITHIN GROUP (ORDER BY key [ASC | DESC], ...)

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl Display for Function

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

Formats the value using the given formatter.

impl Hash for Function

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Ord for Function

fn cmp(&self, other: &Function) -> 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,

Restrict a value to a certain interval.

impl PartialEq for Function

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

fn partial_cmp(&self, other: &Function) -> 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 Spanned for Function

fn span(&self) -> Span

Return the Span (the minimum and maximum Location) for this AST node, by recursively combining the spans of its children.

impl Visit for Function

fn visit<V>(&self, visitor: &mut V) -> ControlFlow<<V as Visitor>::Break>

where V: Visitor,

impl VisitMut for Function

fn visit<V>(&mut self, visitor: &mut V) -> ControlFlow<<V as VisitorMut>::Break>

where V: VisitorMut,

impl Eq for Function

impl StructuralPartialEq for Function