Packages

final class GeneralAggregateFunc extends ExpressionWithToString with AggregateFunc

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
  • REGR_INTERCEPT(input1, input2)
    
    Since 3.4.0
  • REGR_R2(input1, input2)
    
    Since 3.4.0
  • REGR_SLOPE(input1, input2)
    
    Since 3.4.0
  • REGR_SXY(input1, input2)
    
    Since 3.4.0
  • MODE() WITHIN (ORDER BY input1 [ASC|DESC])
    
    Since 4.0.0
  • PERCENTILE_CONT(input1) WITHIN (ORDER BY input2 [ASC|DESC])
    
    Since 4.0.0
  • PERCENTILE_DISC(input1) WITHIN (ORDER BY input2 [ASC|DESC])
    
    Since 4.0.0
Annotations
@Evolving()
Source
GeneralAggregateFunc.java
Since

3.3.0

Linear Supertypes
AggregateFunc, ExpressionWithToString, Serializable, Expression, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeneralAggregateFunc
  2. AggregateFunc
  3. ExpressionWithToString
  4. Serializable
  5. Expression
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GeneralAggregateFunc(name: String, isDistinct: Boolean, children: Array[Expression], orderingWithinGroups: Array[SortValue])
  2. new GeneralAggregateFunc(name: String, isDistinct: Boolean, children: Array[Expression])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def children(): Array[Expression]

    Returns an array of the children of this node.

    Returns an array of the children of this node. Children should not change.

    Definition Classes
    GeneralAggregateFuncExpression
    Annotations
    @Override()
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. def describe(): String

    Format the expression as a human readable SQL-like string.

    Format the expression as a human readable SQL-like string.

    Definition Classes
    Expression
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(o: AnyRef): Boolean
    Definition Classes
    GeneralAggregateFunc → AnyRef → Any
    Annotations
    @Override()
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. def hashCode(): Int
    Definition Classes
    GeneralAggregateFunc → AnyRef → Any
    Annotations
    @Override()
  12. def isDistinct(): Boolean
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def name(): String
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. def orderingWithinGroups(): Array[SortValue]
  19. def references(): Array[NamedReference]

    List of fields or columns that are referenced by this expression.

    List of fields or columns that are referenced by this expression.

    Definition Classes
    Expression
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    ExpressionWithToString → AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AggregateFunc

Inherited from ExpressionWithToString

Inherited from Serializable

Inherited from Expression

Inherited from AnyRef

Inherited from Any

Ungrouped