Class

org.apache.spark.sql.expressions

UserDefinedFunction

Related Doc: package expressions

Permalink

case class UserDefinedFunction(f: AnyRef, dataType: DataType, inputTypes: Option[Seq[DataType]]) extends Product with Serializable

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
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UserDefinedFunction
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UserDefinedFunction(f: AnyRef, dataType: DataType, inputTypes: Option[Seq[DataType]])

    Permalink
    Attributes
    protected[org.apache.spark.sql]

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def apply(exprs: Column*): Column

    Permalink

    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

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  6. def asNonNullable(): UserDefinedFunction

    Permalink

    Updates UserDefinedFunction to non-nullable.

    Updates UserDefinedFunction to non-nullable.

    Since

    2.3.0

  7. def asNondeterministic(): UserDefinedFunction

    Permalink

    Updates UserDefinedFunction to nondeterministic.

    Updates UserDefinedFunction to nondeterministic.

    Since

    2.3.0

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  9. val dataType: DataType

    Permalink

  10. def deterministic: Boolean

    Permalink

    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

  11. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  12. val f: AnyRef

    Permalink

  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  15. val inputTypes: Option[Seq[DataType]]

    Permalink

  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. def nullable: Boolean

    Permalink

    Returns true when the UDF can return a nullable value.

    Returns true when the UDF can return a nullable value.

    Since

    2.3.0

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. def withName(name: String): UserDefinedFunction

    Permalink

    Updates UserDefinedFunction with a given name.

    Updates UserDefinedFunction with a given name.

    Since

    2.3.0

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped