sealed abstract class UserDefinedFunction extends UserDefinedFunctionLike
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
- Alphabetic
- By Inheritance
- UserDefinedFunction
- UserDefinedFunctionLike
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def asNonNullable(): UserDefinedFunction
Updates UserDefinedFunction to non-nullable.
Updates UserDefinedFunction to non-nullable.
- Since
2.3.0
- abstract def asNondeterministic(): UserDefinedFunction
Updates UserDefinedFunction to nondeterministic.
Updates UserDefinedFunction to nondeterministic.
- Since
2.3.0
- 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
- 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
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def name: String
- Definition Classes
- UserDefinedFunctionLike
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)