Aggregate functions
Aggregate functions compute a single result from a set of input values.
For details about the supported syntaxes of aggregate expressions, see Aggregate function calls.
General-purpose aggregate functions
array_agg
Collects all the input values, including nulls, into an array. The ORDER BY
clause is optional and specifies the order of rows processed in the aggregation, which determines the order of the elements in the result array.
avg
Returns the average (arithmetic mean) of all non-null input values or null if no non-null values are provided.
Input types include smallint, int, bigint, numeric, real, and double precision.
Return type is numeric for integer inputs and double precision for float point inputs.
bit_and
Returns the bitwise AND of all non-null input values or null if no non-null values are provided.
bit_or
Returns the bitwise OR of all non-null input values or null if no non-null values are provided.
bool_and
Returns true if all non-null input values are true, otherwise false.
bool_or
Returns true if any non-null input value is true, otherwise false.
count
Returns the number of non-null input values.
The input can be of any supported data type.
count(*)
Returns the number of rows in the input.
jsonb_agg
Collects all the input values, including nulls, into a JSON array. The ORDER BY
clause is optional and specifies the order of rows processed in the aggregation, which determines the order of the elements in the result array.
jsonb_object_agg
Aggregates name/value pairs as a JSON object. Values can be null, but keys cannot.
max
Returns the maximum of the non-null input values, or null if no non-null values are provided.
Input can be of any numeric, string, date/time, or interval type, or an array of these types.
min
Returns the minimum value of the non-null input values, or null if no non-null values are provided.
Input can be of any numeric, string, date/time, or interval type, or an array of these types.
string_agg
Concatenates non-null input values into a string. Each value after the first is preceded by the corresponding delimiter (if it’s not null). If no non-null values are provided, returns null. The ORDER BY
clause is optional and specifies the order of rows processed in the aggregation, which determines the order of the elements in the result array.
sum
Returns the sum of all non-null input values, or null if no non-null values are provided.
Input types include smallint, int, bigint, numeric, real, and double precision.
Return type is bigint for smallint or int inputs, numeric for bigint inputs, otherwise the same as the input data type.
first_value
Returns the first value in an ordered set of values, including nulls.
order_key
is the column or expression used to determine the order of the values. It is required to make the result deterministic.
last_value
Returns the last value in an ordered set of values, including nulls.
Aggregate functions for statistics
stddev_pop
Calculates the population standard deviation of the input values. Returns NULL
if the input contains no non-null values.
stddev_samp
Calculates the sample standard deviation of the input values. Returns NULL
if the input contains fewer than two non-null values.
var_pop
Calculates the population variance of the input values. Returns NULL
if the input contains no non-null values.
var_samp
Calculates the sample variance of the input values. Returns NULL
if the input contains fewer than two non-null values.
Ordered-set aggregate functions
At present, ordered-set aggregate functions support only constant fraction arguments.
mode
Computes the mode, which is the most frequent value of the aggregated argument. If there are multiple equally-frequent values, it arbitrarily chooses the first one.
sort_expression
: Must be of a sortable type.
This example calculates the mode of the values in column1
from table1
.
percentile_cont
At present, percentile_cont
is not supported for streaming queries yet.
Computes the continuous percentile, which is a value corresponding to the specified fraction within the ordered set of aggregated argument values. It can interpolate between adjacent input items if needed.
fraction
: The fraction value representing the desired percentile. It should be between 0 and 1.
This example calculates the median (50th percentile) of the values in column1
from table1
.
If NULL is provided, the function will not calculate a specific percentile and return NULL instead.
percentile_disc
At present, percentile_disc
is not supported for streaming queries yet.
Computes the discrete percentile, which is the first value within the ordered set of aggregated argument values whose position in the ordering equals or exceeds the specified fraction.
fraction
: The fraction value representing the desired percentile. It should be between 0 and 1.
sort_expression
: Must be of a sortable type.
This example calculates the 75th percentile of the values in column1
from table1
.
If NULL is provided, the function will not calculate a specific percentile and return NULL instead.
approx_percentile
PUBLIC PREVIEW
This feature is in the public preview stage, meaning it’s nearing the final product but is not yet fully stable. If you encounter any issues or have feedback, please contact us through our Slack channel. Your input is valuable in helping us improve the feature. For more information, see our Public preview feature list.
Returns an approximate value of the specified percentile from a numeric column.
percentile
: The percentile to approximate. It should be between 0 and 1.relative_error
: Optional. Specifies the maximum allowed error in the approximation. Defaults to 0.01 (1%).percentile_column
: The column from which to calculate the percentile. Must be of a numeric type.
This example calculates the 50th percentile of a numeric column with the default relative error:
Grouping operation functions
Grouping operation functions are used in conjunction with grouping sets to distinguish result rows. The arguments to the grouping()
function are not actually evaluated, but they must exactly match expressions given in the GROUP BY
clause of the associated query level.
grouping
Returns a bit mask indicating which GROUP BY
expressions are not included in the current grouping set. Bits are assigned with the rightmost argument corresponding to the least-significant bit; each bit is 0 if the corresponding expression is included in the grouping criteria of the grouping set generating the current result row, and 1 if it is not included.
Example
Was this page helpful?