Module org.jooq

Package org.jooq

Interface AggregateFunction<T>

All Superinterfaces:

AggregateFilterStep<T>, Field<T>, FieldOrConstraint, FieldOrRow, FieldOrRowOrSelect, GroupField, Named, OrderField<T>, QueryPart, SelectField<T>, SelectFieldOrAsterisk, Serializable, TableElement, Typed<T>, WindowBeforeOverStep<T>, WindowOverStep<T>

All Known Subinterfaces:

GroupConcatOrderByStep, GroupConcatSeparatorStep, QOM.AnyValue<T>, QOM.ArrayAgg<T>, QOM.Avg, QOM.BitAndAgg<T>, QOM.BitNandAgg<T>, QOM.BitNorAgg<T>, QOM.BitOrAgg<T>, QOM.BitXNorAgg<T>, QOM.BitXorAgg<T>, QOM.BoolAnd, QOM.BoolOr, QOM.Collect<T,A>, QOM.Corr, QOM.Count, QOM.CountTable, QOM.CovarPop, QOM.CovarSamp, QOM.JSONArrayAgg<J>, QOM.JSONObjectAgg<J>, QOM.Max<T>, QOM.Median, QOM.Min<T>, QOM.Mode<T>, QOM.MultisetAgg<R>, QOM.Product, QOM.RatioToReport, QOM.RegrAvgX, QOM.RegrAvgY, QOM.RegrCount, QOM.RegrIntercept, QOM.RegrR2, QOM.RegrSlope, QOM.RegrSxx, QOM.RegrSxy, QOM.RegrSyy, QOM.StddevPop, QOM.StddevSamp, QOM.Sum, QOM.VarPop, QOM.VarSamp, QOM.XMLAgg

public interface AggregateFunction<T>
extends AggregateFilterStep<T>

An aggregate function.

An aggregate function is a special field that is usually used in a GROUP BY context. It is also the base for window function construction.

Example:

 // Assuming import static org.jooq.impl.DSL.*;

 using(configuration)
    .select(ACTOR.LAST_NAME, count())
    .from(ACTOR)
    .groupBy(ACTOR.LAST_NAME)
    .orderBy(count().desc())
    .fetch();
 

Instances can be created using various DSL methods and their overloads, such as DSL.count() or DSL.countDistinct(Field).

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
@Nullable Condition	$filterWhere()	Experimental query object model accessor method, see also QOM.
@NotNull AggregateFilterStep<T>	keepDenseRankFirstOrderBy(Collection<? extends OrderField<?>> fields)	Restrict this aggregate function to FIRST values
@NotNull AggregateFilterStep<T>	keepDenseRankFirstOrderBy(OrderField<?>... fields)	Restrict this aggregate function to FIRST values
@NotNull AggregateFilterStep<T>	keepDenseRankLastOrderBy(Collection<? extends OrderField<?>> fields)	Restrict this aggregate function to LAST values
@NotNull AggregateFilterStep<T>	keepDenseRankLastOrderBy(OrderField<?>... fields)	Restrict this aggregate function to LAST values

Methods inherited from interface org.jooq.AggregateFilterStep

filterWhere, filterWhere, filterWhere, filterWhere, filterWhere, filterWhere, filterWhere, filterWhere

Methods inherited from interface org.jooq.Field

abs, acos, add, add, as, as, as, as, asc, ascii, asin, atan, atan2, atan2, avg, avgOver, between, between, between, between, betweenSymmetric, betweenSymmetric, betweenSymmetric, betweenSymmetric, bitAnd, bitAnd, bitLength, bitNand, bitNand, bitNor, bitNor, bitNot, bitOr, bitOr, bitXNor, bitXNor, bitXor, bitXor, cast, cast, cast, ceil, changed, charLength, coalesce, coalesce, coerce, coerce, coerce, collate, collate, collate, compare, compare, compare, compare, concat, concat, concat, contains, contains, containsIgnoreCase, containsIgnoreCase, convert, convert, convert, convertFrom, convertFrom, convertTo, convertTo, cos, cosh, cot, coth, count, countDistinct, countOver, decode, decode, decode, decode, deg, desc, div, div, divide, divide, endsWith, endsWith, endsWithIgnoreCase, endsWithIgnoreCase, eq, eq, eq, eq, equal, equal, equal, equal, equalIgnoreCase, equalIgnoreCase, equals, exp, extract, field, firstValue, floor, from, ge, ge, ge, ge, get, getComment, getName, getValue, greaterOrEqual, greaterOrEqual, greaterOrEqual, greaterOrEqual, greaterThan, greaterThan, greaterThan, greaterThan, greatest, greatest, gt, gt, gt, gt, in, in, in, in, in, isDistinctFrom, isDistinctFrom, isDistinctFrom, isDocument, isFalse, isJson, isNotDistinctFrom, isNotDistinctFrom, isNotDistinctFrom, isNotDocument, isNotJson, isNotNull, isNull, isTrue, lag, lag, lag, lag, lastValue, le, le, le, le, lead, lead, lead, lead, least, least, length, lessOrEqual, lessOrEqual, lessOrEqual, lessOrEqual, lessThan, lessThan, lessThan, lessThan, like, like, like, like, like, likeIgnoreCase, likeIgnoreCase, likeIgnoreCase, likeIgnoreCase, likeRegex, likeRegex, ln, log, lower, lpad, lpad, lpad, lpad, lt, lt, lt, lt, ltrim, max, maxOver, median, min, minOver, minus, minus, mod, mod, modulo, modulo, mul, mul, multiply, multiply, ne, ne, ne, ne, neg, notBetween, notBetween, notBetween, notBetween, notBetweenSymmetric, notBetweenSymmetric, notBetweenSymmetric, notBetweenSymmetric, notContains, notContains, notContainsIgnoreCase, notContainsIgnoreCase, notEqual, notEqual, notEqual, notEqual, notEqualIgnoreCase, notEqualIgnoreCase, notIn, notIn, notIn, notIn, notIn, notLike, notLike, notLike, notLike, notLike, notLikeIgnoreCase, notLikeIgnoreCase, notLikeIgnoreCase, notLikeIgnoreCase, notLikeRegex, notLikeRegex, notSimilarTo, notSimilarTo, notSimilarTo, notSimilarTo, nullif, nullif, nvl, nvl, nvl2, nvl2, octetLength, original, plus, plus, plus, position, position, pow, pow, power, power, rad, rem, rem, repeat, repeat, replace, replace, replace, replace, reset, round, round, rpad, rpad, rpad, rpad, rtrim, shl, shl, shr, shr, sign, similarTo, similarTo, similarTo, similarTo, sin, sinh, sort, sort, sortAsc, sortAsc, sortDefault, sortDesc, sortDesc, sqrt, startsWith, startsWith, startsWithIgnoreCase, startsWithIgnoreCase, stddevPop, stddevPopOver, stddevSamp, stddevSampOver, sub, sub, substring, substring, substring, substring, subtract, subtract, sum, sumOver, tan, tanh, times, times, trim, unaryMinus, unaryPlus, upper, varPop, varPopOver, varSamp, varSampOver

Methods inherited from interface org.jooq.Named

$name, getCommentPart, getQualifiedName, getUnqualifiedName

Methods inherited from interface org.jooq.QueryPart

$replace, $replace, $traverse, $traverse, hashCode, toString

Methods inherited from interface org.jooq.Typed

$dataType, getBinding, getConverter, getDataType, getDataType, getType

Methods inherited from interface org.jooq.WindowOverStep

over, over, over, over, over

Method Details

keepDenseRankFirstOrderBy

@NotNull
@Support(ORACLE)
@Pro
@NotNull AggregateFilterStep<T> keepDenseRankFirstOrderBy(OrderField<?>... fields)

Restrict this aggregate function to FIRST values

An example:

 MAX(id) KEEP (DENSE_RANK FIRST ORDER BY 1)
 

keepDenseRankFirstOrderBy

@NotNull
@Support(ORACLE)
@Pro
@NotNull AggregateFilterStep<T> keepDenseRankFirstOrderBy(Collection<? extends OrderField<?>> fields)

Restrict this aggregate function to FIRST values

An example:

 MAX(id) KEEP (DENSE_RANK FIRST ORDER BY 1)
 

keepDenseRankLastOrderBy

@NotNull
@Support(ORACLE)
@Pro
@NotNull AggregateFilterStep<T> keepDenseRankLastOrderBy(OrderField<?>... fields)

Restrict this aggregate function to LAST values

An example:

 MAX(id) KEEP (DENSE_RANK LAST ORDER BY 1)
 

keepDenseRankLastOrderBy

@NotNull
@Support(ORACLE)
@Pro
@NotNull AggregateFilterStep<T> keepDenseRankLastOrderBy(Collection<? extends OrderField<?>> fields)

Restrict this aggregate function to LAST values

An example:

 MAX(id) KEEP (DENSE_RANK LAST ORDER BY 1)
 

$filterWhere

@Experimental
@Nullable
@Nullable Condition $filterWhere()

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.