Packages

c

org.apache.spark.sql.connector.expressions.aggregate

UserDefinedAggregateFunc

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()
Since

3.4.0

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

Instance Constructors

  1. new UserDefinedAggregateFunc(name: String, canonicalName: 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 canonicalName(): String
  6. 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()
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. 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
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(o: Any): Boolean
    Definition Classes
    UserDefinedAggregateFunc → AnyRef → Any
    Annotations
    @Override()
  11. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    UserDefinedAggregateFunc → AnyRef → Any
    Annotations
    @Override()
  14. def isDistinct(): Boolean
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def name(): String
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. 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
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    ExpressionWithToString → AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AggregateFunc

Inherited from ExpressionWithToString

Inherited from Serializable

Inherited from Serializable

Inherited from Expression

Inherited from AnyRef

Inherited from Any

Ungrouped