AggregateFunctionExpression<D extends Object> class final

An expression invoking an aggregate function.

Aggregate functions, like count() or sum() collapse the entire data set (or a partition of it, if GROUP BY is used) into a single value.

Drift exposes direct bindings to most aggregate functions (e.g. via BaseAggregate.count). This class is useful when writing custom aggregate function invocations.

Inheritance
Available extensions

Constructors

AggregateFunctionExpression(String functionName, List<FunctionParameter> arguments, {Expression<bool>? filter, bool distinct = false, OrderBy? orderBy})
Creates an aggregate function expression from the syntactic components.

Properties

arguments → List<FunctionParameter>
The arguments to pass to the function.
final
date → Expression<String>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Formats this datetime in the format year-month-day.
no setter
datetime → Expression<String>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Formats this datetime in the format year-month-day hour:minute:second.
no setter
day → Expression<int>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Extracts the day from this datetime expression.
no setter
distinct → bool
Whether only distinct rows should be passed to the function.
final
driftSqlType → BaseSqlType<D>
The BaseSqlType backing this expression.
no setterinherited
filter → Where?
An optional filter clause only passing rows matching this condition into the function.
final
functionName → String
The name of the aggregate function to invoke.
final
hashCode → int
The hash code for this object.
no setteroverride
hour → Expression<int>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Extracts the hour from this datetime expression.
no setter
isLiteral → bool
Whether this expression is a literal. Some use-sites need to put parentheses around non-literals.
no setterinherited
julianday → Expression<double>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Formats this datetime in the Julian day format - a fractional number of days since noon in Greenwich on November 24, 4714 B.C.
no setter
length → Expression<int>

Available on Expression<String>, provided by the StringExpressionOperators extension

Calls the sqlite function LENGTH on this string, which counts the number of characters in this string. Note that, in most sqlite installations, length may not support all unicode rules.
no setter
minute → Expression<int>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Extracts the minute from this datetime expression.
no setter
month → Expression<int>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Extracts the month from this datetime expression.
no setter
orderBy → OrderBy?
The order in which rows of the current group should be passed to the aggregate function.
final
precedence → Precedence
The precedence of this expression. This can be used to automatically put parentheses around expressions as needed.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
second → Expression<int>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Extracts the second from this datetime expression.
no setter
secondsSinceEpoch → Expression<int>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Returns an expression containing the amount of seconds from the unix epoch (January 1st, 1970) to this datetime expression.
no setter
time → Expression<String>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Formats this datetime in the format hour:minute:second.
no setter
unixepoch → Expression<int>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Formats this datetime as a unix timestamp - the number of seconds since 1970-01-01 00:00:00 UTC.
no setter
year → Expression<int>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Extracts the year from this datetime expression.
no setter

Methods

abs() → Expression<BigInt>

Available on Expression<BigInt>, provided by the ArithmeticBigIntExpr extension

Calculates the absolute value of this number.
abs() → Expression<DT>

Available on Expression<DT>, provided by the ArithmeticExpr extension

Calculates the absolute value of this number.
avg({Expression<bool>? filter}) → Expression<DateTime>

Available on Expression<DateTime>, provided by the DateTimeAggregate extension

Return the average of all non-null values in this group. To only consider rows matching a predicate, you can set the optional filter. Note that filter is only available from sqlite 3.30, released on 2019-10-04. Most devices will use an older sqlite version.
avg({Expression<bool>? filter}) → Expression<double>

Available on Expression<DT>, provided by the ArithmeticAggregates extension

Return the average of all non-null values in this group.
avg({Expression<bool>? filter}) → Expression<double>

Available on Expression<BigInt>, provided by the BigIntAggregates extension

Return the average of all non-null values in this group.
bitwiseAnd(Expression<int> other) → Expression<int>

Available on Expression<int>, provided by the BitwiseInt extension

Returns the bitwise-and operation between this and other.
bitwiseAnd(Expression<BigInt> other) → Expression<BigInt>

Available on Expression<BigInt>, provided by the BitwiseBigInt extension

Returns the bitwise-and operation between this and other.
bitwiseOr(Expression<int> other) → Expression<int>

Available on Expression<int>, provided by the BitwiseInt extension

Returns the bitwise-or operation between this and other.
bitwiseOr(Expression<BigInt> other) → Expression<BigInt>

Available on Expression<BigInt>, provided by the BitwiseBigInt extension

Returns the bitwise-or operation between this and other.
caseMatch<T extends Object>({required Map<Expression<D>, Expression<T>> when, Expression<T>? orElse}) → Expression<T>
A CASE WHEN construct using the current expression as a base.
inherited
cast<D2 extends Object>([BaseSqlType<D2>? type]) → Expression<D2>
Generates a CAST(expression AS TYPE) expression.
inherited
collate(Collate collate) → Expression<String>

Available on Expression<String>, provided by the StringExpressionOperators extension

Uses the given collate sequence when comparing this column to other values.
contains(String substring) → Expression<bool>

Available on Expression<String>, provided by the StringExpressionOperators extension

Whether this expression contains substring.
count({bool distinct = false, Expression<bool>? filter}) → Expression<int>

Available on Expression<DT>, provided by the BaseAggregate extension

Returns how often this expression is non-null in the current group.
dartCast<D2 extends Object>({CustomSqlType<D2>? customType}) → Expression<D2>
Casts this expression to an expression of D.
inherited
equals(D compare) → Expression<bool>
Whether this column is equal to the given value, which must have a fitting type. The compare value will be written as a variable using prepared statements, so there is no risk of an SQL-injection.
inherited
equalsExp(Expression<D> compare) → Expression<bool>
Whether this expression is equal to the given expression.
inherited
equalsNullable(D? compare) → Expression<bool>
Compares the value of this column to compare or null.
inherited
groupConcat({String separator = ',', bool distinct = false, Expression<bool>? filter, OrderBy? orderBy}) → Expression<String>

Available on Expression<DT>, provided by the BaseAggregate extension

Returns the concatenation of all non-null values in the current group, joined by the separator.
iif<T extends Object>(Expression<bool> predicate, Expression<T> ifFalse) → Expression<T>
Evaluates to this if predicate is true, otherwise evaluates to ifFalse.
inherited
isBetween(Expression<DT> lower, Expression<DT> higher, {bool not = false}) → Expression<bool>

Available on Expression<DT>, provided by the ComparableExpr extension

Returns an expression evaluating to true if this expression is between lower and higher (both inclusive).
isBetweenValues(DT lower, DT higher, {bool not = false}) → Expression<bool>

Available on Expression<DT>, provided by the ComparableExpr extension

Returns an expression evaluating to true if this expression is between lower and higher (both inclusive).
isBiggerOrEqual(Expression<DT> other) → Expression<bool>

Available on Expression<DT>, provided by the ComparableExpr extension

Returns an expression that is true if this expression is bigger than or equal to he other expression.
isBiggerOrEqualValue(DT other) → Expression<bool>

Available on Expression<DT>, provided by the ComparableExpr extension

Returns an expression that is true if this expression is bigger than or equal to he other value.
isBiggerThan(Expression<DT> other) → Expression<bool>

Available on Expression<DT>, provided by the ComparableExpr extension

Returns an expression that is true if this expression is strictly bigger than the other expression.
isBiggerThanValue(DT other) → Expression<bool>

Available on Expression<DT>, provided by the ComparableExpr extension

Returns an expression that is true if this expression is strictly bigger than the other value.
isExp(Expression<D> other) → Expression<bool>
Generates an IS expression in SQL, comparing this expression with the other expression.
inherited
isIn(Iterable<D> values) → Expression<bool>
An expression that is true if this resolves to any of the values in values.
inherited
isInExp(List<Expression<D>> expressions) → Expression<bool>
An expression that evaluates to true if this expression resolves to a value that one of the expressions resolve to as well.
inherited
isInQuery(BaseSelectStatement select) → Expression<bool>
An expression checking whether this is included in any row of the provided select statement.
inherited
isNotExp(Expression<D> other) → Expression<bool>
Generates an IS NOT expression in SQL, comparing this expression with the other expression.
inherited
isNotIn(Iterable<D> values) → Expression<bool>
An expression that is true if this does not resolve to any of the values in values.
inherited
isNotInExp(List<Expression<D>> expressions) → Expression<bool>
An expression that evaluates to true if this expression does not resolve to any value that the expressions resolve to.
inherited
isNotInQuery(BaseSelectStatement select) → Expression<bool>
An expression checking whether this is not included in any row of the provided select statement.
inherited
isNotNull() → Expression<bool>
Expression that is true if the inner expression resolves to a non-null value.
inherited
isNotValue(D value) → Expression<bool>
Generates an IS NOT expression in SQL, comparing this expression with the Dart value.
inherited
isNull() → Expression<bool>
Expression that is true if the inner expression resolves to a null value.
inherited
isSmallerOrEqual(Expression<DT> other) → Expression<bool>

Available on Expression<DT>, provided by the ComparableExpr extension

Returns an expression that is true if this expression is smaller than or equal to he other expression.
isSmallerOrEqualValue(DT other) → Expression<bool>

Available on Expression<DT>, provided by the ComparableExpr extension

Returns an expression that is true if this expression is smaller than or equal to he other value.
isSmallerThan(Expression<DT> other) → Expression<bool>

Available on Expression<DT>, provided by the ComparableExpr extension

Returns an expression that is true if this expression is strictly smaller than the other expression.
isSmallerThanValue(DT other) → Expression<bool>

Available on Expression<DT>, provided by the ComparableExpr extension

Returns an expression that is true if this expression is strictly smaller than the other value.
isValue(D value) → Expression<bool>
Generates an IS expression in SQL, comparing this expression with the Dart value.
inherited
like(String regex, {String? escapeChar}) → Expression<bool>

Available on Expression<String>, provided by the StringExpressionOperators extension

Whether this column matches the given expression.
likeExp(Expression<String> regex, {Expression<String>? escape}) → Expression<bool>

Available on Expression<String>, provided by the StringExpressionOperators extension

Whether this column matches the given expression.
lower() → Expression<String>

Available on Expression<String>, provided by the StringExpressionOperators extension

Calls the sqlite function LOWER on this string. Please note that, in most sqlite installations, this only affects ascii chars.
max({Expression<bool>? filter}) → Expression<BigInt>

Available on Expression<BigInt>, provided by the BigIntAggregates extension

Return the maximum of all non-null values in this group.
max({Expression<bool>? filter}) → Expression<DT>

Available on Expression<DT>, provided by the ArithmeticAggregates extension

Return the maximum of all non-null values in this group.
max({Expression<bool>? filter}) → Expression<DT>

Available on Expression<DT>, provided by the BaseAggregate extension

Return the maximum of all non-null values in this group.
max({Expression<bool>? filter}) → Expression<DateTime>

Available on Expression<DateTime>, provided by the DateTimeAggregate extension

Return the maximum of all non-null values in this group.
min({Expression<bool>? filter}) → Expression<DT>

Available on Expression<DT>, provided by the ArithmeticAggregates extension

Return the minimum of all non-null values in this group.
min({Expression<bool>? filter}) → Expression<BigInt>

Available on Expression<BigInt>, provided by the BigIntAggregates extension

Return the minimum of all non-null values in this group.
min({Expression<bool>? filter}) → Expression<DateTime>

Available on Expression<DateTime>, provided by the DateTimeAggregate extension

Return the minimum of all non-null values in this group.
min({Expression<bool>? filter}) → Expression<DT>

Available on Expression<DT>, provided by the BaseAggregate extension

Return the minimum of all non-null values in this group.
modify(DateTimeModifier modifier) → Expression<DateTime>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Apply a modifier that alters the date and/or time.
modifyAll(Iterable<DateTimeModifier> modifiers) → Expression<DateTime>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Applies modifiers that alters the date and/or time.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
not() → Expression<bool>

Available on Expression<bool>, provided by the BooleanExpressionOperators extension

Negates this boolean expression. The returned expression is true if this is false, and vice versa.
nullIf(Expression<D> matcher) → Expression<D>
Returns null if matcher is equal to this expression, this otherwise.
inherited
regexp(String regex, {bool multiLine = false, bool caseSensitive = true, bool unicode = false, bool dotAll = false}) → Expression<bool>

Available on Expression<String>, provided by the StringExpressionOperators extension

Matches this string against the regular expression in regex.
roundToInt() → Expression<int>

Available on Expression<DT>, provided by the ArithmeticExpr extension

Rounds this expression to the nearest integer.
roundToInt() → Expression<int>

Available on Expression<BigInt>, provided by the ArithmeticBigIntExpr extension

Rounds this expression to the nearest integer.
strftime(String format) → Expression<String>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Formats this datetime according to the format string specified as the first argument. The format string supports the most common substitutions found in the strftime() function from the standard C library plus two new substitutions, %f and %J. The following is a complete list of valid strftime() substitutions:
substr(int start, [int? length]) → Expression<String>

Available on Expression<String>, provided by the StringExpressionOperators extension

Calls the substr function on this string.
substrExpr(Expression<int> start, [Expression<int>? length]) → Expression<String>

Available on Expression<String>, provided by the StringExpressionOperators extension

Calls the substr function with arbitrary expressions as arguments.
sum({Expression<bool>? filter}) → Expression<DT>

Available on Expression<DT>, provided by the ArithmeticAggregates extension

Calculate the sum of all non-null values in the group.
sum({Expression<bool>? filter}) → Expression<BigInt>

Available on Expression<BigInt>, provided by the BigIntAggregates extension

Calculate the sum of all non-null values in the group.
toString() → String
A string representation of this object.
inherited
total({Expression<bool>? filter}) → Expression<double>

Available on Expression<BigInt>, provided by the BigIntAggregates extension

Calculate the sum of all non-null values in the group.
total({Expression<bool>? filter}) → Expression<double>

Available on Expression<DT>, provided by the ArithmeticAggregates extension

Calculate the sum of all non-null values in the group.
trim() → Expression<String>

Available on Expression<String>, provided by the StringExpressionOperators extension

Removes spaces from both ends of this string.
trimLeft() → Expression<String>

Available on Expression<String>, provided by the StringExpressionOperators extension

Removes spaces from the beginning of this string.
trimRight() → Expression<String>

Available on Expression<String>, provided by the StringExpressionOperators extension

Removes spaces from the end of this string.
upper() → Expression<String>

Available on Expression<String>, provided by the StringExpressionOperators extension

Calls the sqlite function UPPER on this string. Please note that, in most sqlite installations, this only affects ascii chars.
writeAroundPrecedence(GenerationContext context, Precedence precedence) → void
Writes this expression into the GenerationContext, assuming that there's an outer expression with precedence. If the Expression.precedence of this expression is lower, it will be wrap}ped in
inherited
writeInner(GenerationContext ctx, Expression<Object> inner) → void
If this Expression wraps an inner expression, this utility method can be used inside writeInto to write that inner expression while wrapping it in parentheses if necessary.
inherited
writeInto(GenerationContext context) → void
Writes this component into the context by writing to its GenerationContext.buffer or by introducing bound variables. When writing into the buffer, no whitespace around the this component should be introduced. When a component consists of multiple composed component, it's responsible for introducing whitespace between its child components.
override

Operators

operator &(Expression<bool> other) → Expression<bool>

Available on Expression<bool>, provided by the BooleanExpressionOperators extension

Returns an expression that is true iff both this and other are true.
operator *(Expression<BigInt> other) → Expression<BigInt>

Available on Expression<BigInt>, provided by the ArithmeticBigIntExpr extension

Performs a multiplication (this * other) in sql.
operator *(Expression<DT> other) → Expression<DT>

Available on Expression<DT>, provided by the ArithmeticExpr extension

Performs a multiplication (this * other) in sql.
operator +(Expression<BigInt> other) → Expression<BigInt>

Available on Expression<BigInt>, provided by the ArithmeticBigIntExpr extension

Performs an addition (this + other) in sql.
operator +(Expression<DT> other) → Expression<DT>

Available on Expression<DT>, provided by the ArithmeticExpr extension

Performs an addition (this + other) in sql.
operator +(Duration duration) → Expression<DateTime>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Adds a duration to this date.
operator +(Expression<String> other) → Expression<String>

Available on Expression<String>, provided by the StringExpressionOperators extension

Performs a string concatenation in sql by appending other to this.
operator -(Expression<BigInt> other) → Expression<BigInt>

Available on Expression<BigInt>, provided by the ArithmeticBigIntExpr extension

Performs a subtraction (this - other) in sql.
operator -(Expression<DT> other) → Expression<DT>

Available on Expression<DT>, provided by the ArithmeticExpr extension

Performs a subtraction (this - other) in sql.
operator -(Duration duration) → Expression<DateTime>

Available on Expression<DateTime>, provided by the DateTimeExpressions extension

Subtracts duration from this date.
operator /(Expression<BigInt> other) → Expression<BigInt>

Available on Expression<BigInt>, provided by the ArithmeticBigIntExpr extension

Performs a division (this / other) in sql.
operator /(Expression<DT> other) → Expression<DT>

Available on Expression<DT>, provided by the ArithmeticExpr extension

Performs a division (this / other) in sql.
operator ==(Object other) → bool
The equality operator.
override
operator unary-() → Expression<BigInt>

Available on Expression<BigInt>, provided by the ArithmeticBigIntExpr extension

Returns the negation of this value.
operator unary-() → Expression<DT>

Available on Expression<DT>, provided by the ArithmeticExpr extension

Returns the negation of this value.
operator |(Expression<bool> other) → Expression<bool>

Available on Expression<bool>, provided by the BooleanExpressionOperators extension

Returns an expression that is true if this or other are true.
operator ~() → Expression<BigInt>

Available on Expression<BigInt>, provided by the BitwiseBigInt extension

Flips all bits in this value (turning 0 to 1 and vice-versa) and returns the result.
operator ~() → Expression<int>

Available on Expression<int>, provided by the BitwiseInt extension

Flips all bits in this value (turning 0 to 1 and vice-versa) and returns the result.