Packages

class UserDefinedAggregateFunc extends ExpressionWithToString with AggregateFunc

The general representation of user defined aggregate function, which implements AggregateFunc, contains the upper-cased function name, the canonical function name, the isDistinct flag and all the inputs. Note that Spark cannot push down aggregate with this function partially to the source, but can only push down the entire aggregate.

Annotations
@Evolving()
Source
UserDefinedAggregateFunc.java
Since

3.4.0

Linear Supertypes
AggregateFunc, ExpressionWithToString, Serializable, Expression, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UserDefinedAggregateFunc
  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 UserDefinedAggregateFunc(name: String, canonicalName: String, isDistinct: Boolean, children: Array[Expression])

Value Members

  1. def canonicalName(): String
  2. 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
    UserDefinedAggregateFunc → Expression
    Annotations
    @Override()
  3. 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
  4. def equals(o: AnyRef): Boolean
    Definition Classes
    UserDefinedAggregateFunc → AnyRef → Any
    Annotations
    @Override()
  5. def hashCode(): Int
    Definition Classes
    UserDefinedAggregateFunc → AnyRef → Any
    Annotations
    @Override()
  6. def isDistinct(): Boolean
  7. def name(): String
  8. 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
  9. def toString(): String
    Definition Classes
    ExpressionWithToString → AnyRef → Any