org.jooq

Interface AggregateFunction<T>

All Superinterfaces:

Field<T>, GroupField, QueryPart, Serializable, WindowOverStep<T>

All Known Subinterfaces:

GroupConcatOrderByStep, GroupConcatSeparatorStep

public interface AggregateFunction<T>
extends Field<T>, WindowOverStep<T>

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.

Author:

Lukas Eder

Method Summary

Methods

Modifier and Type	Method and Description
WindowBeforeOverStep<T>	keepDenseRankFirstOrderBy(Collection<? extends SortField<?>> fields) Restrict this aggregate function to FIRST values An example: MAX(id) KEEP (DENSE_RANK FIRST ORDER BY 1) This clause is only available on MIN, MAX, SUM, AVG, COUNT, VARIANCE, or STDDEV functions.
WindowBeforeOverStep<T>	keepDenseRankFirstOrderBy(Field<?>... fields) Restrict this aggregate function to FIRST values An example: MAX(id) KEEP (DENSE_RANK FIRST ORDER BY 1) This clause is only available on MIN, MAX, SUM, AVG, COUNT, VARIANCE, or STDDEV functions.
WindowBeforeOverStep<T>	keepDenseRankFirstOrderBy(SortField<?>... fields) Restrict this aggregate function to FIRST values An example: MAX(id) KEEP (DENSE_RANK FIRST ORDER BY 1) This clause is only available on MIN, MAX, SUM, AVG, COUNT, VARIANCE, or STDDEV functions.
WindowBeforeOverStep<T>	keepDenseRankLastOrderBy(Collection<? extends SortField<?>> fields) Restrict this aggregate function to FIRST values An example: MAX(id) KEEP (DENSE_RANK LAST ORDER BY 1) This clause is only available on MIN, MAX, SUM, AVG, COUNT, VARIANCE, or STDDEV functions.
WindowBeforeOverStep<T>	keepDenseRankLastOrderBy(Field<?>... fields) Restrict this aggregate function to FIRST values An example: MAX(id) KEEP (DENSE_RANK LAST ORDER BY 1) This clause is only available on MIN, MAX, SUM, AVG, COUNT, VARIANCE, or STDDEV functions.
WindowBeforeOverStep<T>	keepDenseRankLastOrderBy(SortField<?>... fields) Restrict this aggregate function to FIRST values An example: MAX(id) KEEP (DENSE_RANK LAST ORDER BY 1) This clause is only available on MIN, MAX, SUM, AVG, COUNT, VARIANCE, or STDDEV functions.
WindowPartitionByStep<T>	over() Turn this aggregate function into a window function.
WindowFinalStep<T>	over(Name name) Turn this aggregate function into a window function referencing a window name.
WindowFinalStep<T>	over(String name) Turn this aggregate function into a window function referencing a window name.
WindowFinalStep<T>	over(WindowDefinition definition) Turn this aggregate function into a window function referencing a window definition.
WindowFinalStep<T>	over(WindowSpecification specification) Turn this aggregate function into a window function.

Methods inherited from interface org.jooq.Field

abs, acos, add, add, 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, charLength, coalesce, coalesce, coerce, coerce, coerce, compare, compare, compare, compare, concat, concat, contains, contains, cos, cosh, cot, coth, count, countDistinct, countOver, decode, decode, decode, decode, deg, desc, div, div, divide, divide, endsWith, endsWith, eq, eq, eq, eq, equal, equal, equal, equal, equalIgnoreCase, equalIgnoreCase, equals, exp, extract, firstValue, floor, ge, ge, ge, ge, getComment, getDataType, getDataType, getName, getType, greaterOrEqual, greaterOrEqual, greaterOrEqual, greaterOrEqual, greaterThan, greaterThan, greaterThan, greaterThan, greatest, greatest, gt, gt, gt, gt, in, in, in, in, isDistinctFrom, isDistinctFrom, isFalse, isNotDistinctFrom, isNotDistinctFrom, 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, 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, notEqual, notEqual, notEqual, notEqual, notEqualIgnoreCase, notEqualIgnoreCase, notIn, notIn, notIn, notIn, notLike, notLike, notLike, notLike, notLikeIgnoreCase, notLikeIgnoreCase, notLikeIgnoreCase, notLikeIgnoreCase, notLikeRegex, notLikeRegex, nullif, nullif, nvl, nvl, nvl2, nvl2, octetLength, plus, plus, position, position, pow, power, rad, repeat, repeat, replace, replace, replace, replace, round, round, rpad, rpad, rpad, rpad, rtrim, shl, shl, shr, shr, sign, sin, sinh, sort, sort, sortAsc, sortAsc, sortDesc, sortDesc, sqrt, startsWith, startsWith, stddevPop, stddevPopOver, stddevSamp, stddevSampOver, sub, sub, substring, substring, substring, substring, subtract, subtract, sum, sumOver, tan, tanh, trim, upper, varPop, varPopOver, varSamp, varSampOver

Methods inherited from interface org.jooq.QueryPart

hashCode, toString

Method Detail

over

@Support(value={CUBRID,DB2,POSTGRES,ORACLE,SQLSERVER,SYBASE})
WindowPartitionByStep<T> over()

Turn this aggregate function into a window function.

An example:

 MAX(id) OVER (PARTITION BY 1)
 

Window functions are supported in CUBRID, DB2, Postgres, Oracle, SQL Server and Sybase.

Specified by:

over in interface WindowOverStep<T>

over

@Support(value={CUBRID,DB2,POSTGRES,ORACLE,SQLSERVER,SYBASE})
WindowFinalStep<T> over(Name name)

Turn this aggregate function into a window function referencing a window name.

An example:

 MAX(id) OVER my_window
 

Window functions are supported in CUBRID, DB2, Postgres, Oracle, SQL Server and Sybase. If the WINDOW clause is not supported (see SelectWindowStep.window(WindowDefinition...), then referenced windows will be inlined.

Specified by:

over in interface WindowOverStep<T>

over

@Support(value={CUBRID,DB2,POSTGRES,ORACLE,SQLSERVER,SYBASE})
WindowFinalStep<T> over(String name)

Turn this aggregate function into a window function referencing a window name.

An example:

 MAX(id) OVER my_window
 

Window functions are supported in CUBRID, DB2, Postgres, Oracle, SQL Server and Sybase. If the WINDOW clause is not supported (see SelectWindowStep.window(WindowDefinition...), then referenced windows will be inlined.

Specified by:

over in interface WindowOverStep<T>

over

@Support(value={CUBRID,DB2,POSTGRES,ORACLE,SQLSERVER,SYBASE})
WindowFinalStep<T> over(WindowSpecification specification)

Turn this aggregate function into a window function.

An example:

 MAX(id) OVER (PARTITION BY 1)
 

Window functions are supported in CUBRID, DB2, Postgres, Oracle, SQL Server and Sybase.

Specified by:

over in interface WindowOverStep<T>

over

@Support(value={CUBRID,DB2,POSTGRES,ORACLE,SQLSERVER,SYBASE})
WindowFinalStep<T> over(WindowDefinition definition)

Turn this aggregate function into a window function referencing a window definition.

An example:

 MAX(id) OVER my_window
 

Window functions are supported in CUBRID, DB2, Postgres, Oracle, SQL Server and Sybase. If the WINDOW clause is not supported (see SelectWindowStep.window(WindowDefinition...), then referenced windows will be inlined.

Specified by:

over in interface WindowOverStep<T>

keepDenseRankFirstOrderBy

@Support(value=ORACLE)
WindowBeforeOverStep<T> keepDenseRankFirstOrderBy(Field<?>... fields)

Restrict this aggregate function to FIRST values

An example:

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

This clause is only available on MIN, MAX, SUM, AVG, COUNT, VARIANCE, or STDDEV functions.

keepDenseRankFirstOrderBy

@Support(value=ORACLE)
WindowBeforeOverStep<T> keepDenseRankFirstOrderBy(SortField<?>... fields)

Restrict this aggregate function to FIRST values

An example:

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

This clause is only available on MIN, MAX, SUM, AVG, COUNT, VARIANCE, or STDDEV functions.

keepDenseRankFirstOrderBy

@Support(value=ORACLE)
WindowBeforeOverStep<T> keepDenseRankFirstOrderBy(Collection<? extends SortField<?>> fields)

Restrict this aggregate function to FIRST values

An example:

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

This clause is only available on MIN, MAX, SUM, AVG, COUNT, VARIANCE, or STDDEV functions.

keepDenseRankLastOrderBy

@Support(value=ORACLE)
WindowBeforeOverStep<T> keepDenseRankLastOrderBy(Field<?>... fields)

Restrict this aggregate function to FIRST values

An example:

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

This clause is only available on MIN, MAX, SUM, AVG, COUNT, VARIANCE, or STDDEV functions.

keepDenseRankLastOrderBy

@Support(value=ORACLE)
WindowBeforeOverStep<T> keepDenseRankLastOrderBy(SortField<?>... fields)

Restrict this aggregate function to FIRST values

An example:

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

This clause is only available on MIN, MAX, SUM, AVG, COUNT, VARIANCE, or STDDEV functions.

keepDenseRankLastOrderBy

@Support(value=ORACLE)
WindowBeforeOverStep<T> keepDenseRankLastOrderBy(Collection<? extends SortField<?>> fields)

Restrict this aggregate function to FIRST values

An example:

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

This clause is only available on MIN, MAX, SUM, AVG, COUNT, VARIANCE, or STDDEV functions.