Packages

c

org.apache.spark.sql.connector.expressions

UserDefinedScalarFunc

class UserDefinedScalarFunc extends ExpressionWithToString

The general representation of user defined scalar function, which contains the upper-cased function name, canonical function name and all the children expressions.

Annotations
@Evolving()
Source
UserDefinedScalarFunc.java
Since

3.4.0

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

Instance Constructors

  1. new UserDefinedScalarFunc(name: String, canonicalName: String, 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
    UserDefinedScalarFunc → 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
    UserDefinedScalarFunc → AnyRef → Any
    Annotations
    @Override()
  5. def hashCode(): Int
    Definition Classes
    UserDefinedScalarFunc → AnyRef → Any
    Annotations
    @Override()
  6. def name(): String
  7. 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
  8. def toString(): String
    Definition Classes
    ExpressionWithToString → AnyRef → Any