Packages

c

org.apache.spark.sql.expressions

UserDefinedFunction

sealed abstract class UserDefinedFunction extends AnyRef

A user-defined function. To create one, use the udf functions in functions.

As an example:

// Define a UDF that returns true or false based on some numeric score.
val predict = udf((score: Double) => score > 0.5)

// Projects a column that adds a prediction column based on the score column.
df.select( predict(df("score")) )
Annotations
@Stable()
Source
UserDefinedFunction.scala
Since

1.3.0

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UserDefinedFunction
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def apply(exprs: Column*): Column

    Returns an expression that invokes the UDF, using the given arguments.

    Returns an expression that invokes the UDF, using the given arguments.

    Annotations
    @varargs()
    Since

    1.3.0

  2. abstract def asNonNullable(): UserDefinedFunction

    Updates UserDefinedFunction to non-nullable.

    Updates UserDefinedFunction to non-nullable.

    Since

    2.3.0

  3. abstract def asNondeterministic(): UserDefinedFunction

    Updates UserDefinedFunction to nondeterministic.

    Updates UserDefinedFunction to nondeterministic.

    Since

    2.3.0

  4. abstract def deterministic: Boolean

    Returns true iff the UDF is deterministic, i.e.

    Returns true iff the UDF is deterministic, i.e. the UDF produces the same output given the same input.

    Since

    2.3.0

  5. abstract def nullable: Boolean

    Returns true when the UDF can return a nullable value.

    Returns true when the UDF can return a nullable value.

    Since

    2.3.0

  6. abstract def withName(name: String): UserDefinedFunction

    Updates UserDefinedFunction with a given name.

    Updates UserDefinedFunction with a given name.

    Since

    2.3.0

Concrete 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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 AnyRef

Inherited from Any

Ungrouped