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. All

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