org.apache.spark.sql.connector.expressions

aggregate

package aggregate

Type Members

trait AggregateFunc extends Expression with Serializable
Base class of the Aggregate Functions.
Base class of the Aggregate Functions.

Annotations
@Evolving()
Since
3.2.0
final class Aggregation extends Serializable
Aggregation in SQL statement.
Aggregation in SQL statement.

Annotations
@Evolving()
Since
3.2.0
final class Avg extends AggregateFunc
An aggregate function that returns the mean of all the values in a group.
An aggregate function that returns the mean of all the values in a group.

Annotations
@Evolving()
Since
3.3.0
final class Count extends AggregateFunc
An aggregate function that returns the number of the specific row in a group.
An aggregate function that returns the number of the specific row in a group.

Annotations
@Evolving()
Since
3.2.0
final class CountStar extends AggregateFunc
An aggregate function that returns the number of rows in a group.
An aggregate function that returns the number of rows in a group.

Annotations
@Evolving()
Since
3.2.0
final class GeneralAggregateFunc extends AggregateFunc
The general implementation of AggregateFunc, which contains the upper-cased function name, the isDistinct flag and all the inputs.
The general implementation of AggregateFunc, which contains the upper-cased function name, the isDistinct flag and all the inputs. Note that Spark cannot push down partial aggregate with this function to the source, but can only push down the entire aggregate.
The currently supported SQL aggregate functions:
- ```
VAR_POP(input1)
```
  Since 3.3.0
- ```
VAR_SAMP(input1)
```
  Since 3.3.0
- ```
STDDEV_POP(input1)
```
  Since 3.3.0
- ```
STDDEV_SAMP(input1)
```
  Since 3.3.0
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
STDDEV_SAMP(input1)
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
STDDEV_POP(input1)
- ```
STDDEV_SAMP(input1)
```
  Since 3.3.0
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
STDDEV_SAMP(input1)
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
VAR_SAMP(input1)
- ```
STDDEV_POP(input1)
```
  Since 3.3.0
- ```
STDDEV_SAMP(input1)
```
  Since 3.3.0
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
STDDEV_SAMP(input1)
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
STDDEV_POP(input1)
- ```
STDDEV_SAMP(input1)
```
  Since 3.3.0
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
STDDEV_SAMP(input1)
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
VAR_POP(input1)
- ```
VAR_SAMP(input1)
```
  Since 3.3.0
- ```
STDDEV_POP(input1)
```
  Since 3.3.0
- ```
STDDEV_SAMP(input1)
```
  Since 3.3.0
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
STDDEV_SAMP(input1)
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
STDDEV_POP(input1)
- ```
STDDEV_SAMP(input1)
```
  Since 3.3.0
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
STDDEV_SAMP(input1)
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
VAR_SAMP(input1)
- ```
STDDEV_POP(input1)
```
  Since 3.3.0
- ```
STDDEV_SAMP(input1)
```
  Since 3.3.0
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
STDDEV_SAMP(input1)
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
STDDEV_POP(input1)
- ```
STDDEV_SAMP(input1)
```
  Since 3.3.0
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
STDDEV_SAMP(input1)
- ```
COVAR_POP(input1, input2)
```
  Since 3.3.0
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_POP(input1, input2)
- ```
COVAR_SAMP(input1, input2)
```
  Since 3.3.0
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
COVAR_SAMP(input1, input2)
- ```
CORR(input1, input2)
```
  Since 3.3.0
CORR(input1, input2)
Annotations
@Evolving()
Since
3.3.0
final class Max extends AggregateFunc
An aggregate function that returns the maximum value in a group.
An aggregate function that returns the maximum value in a group.

Annotations
@Evolving()
Since
3.2.0
final class Min extends AggregateFunc
An aggregate function that returns the minimum value in a group.
An aggregate function that returns the minimum value in a group.

Annotations
@Evolving()
Since
3.2.0
final class Sum extends AggregateFunc
An aggregate function that returns the summation of all the values in a group.
An aggregate function that returns the summation of all the values in a group.

Annotations
@Evolving()
Since
3.2.0

Packages

aggregate

package aggregate

Type Members

Ungrouped

Packages

aggregate 

package aggregate

Type Members

Ungrouped

aggregate