org.apache.spark.sql

Class UserDefinedFunction

java.lang.Object

org.apache.spark.sql.UserDefinedFunction

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

public class UserDefinedFunction
extends java.lang.Object
implements scala.Product, scala.Serializable

A user-defined function. To create one, use the udf functions in functions. As an example:

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

   // Projects a column that adds a prediction column based on the score column.
   df.select( predict(df("score")) )
 

Since:

1.3.0

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserDefinedFunction(java.lang.Object f, DataType dataType, scala.collection.Seq<DataType> inputTypes)

Method Summary

Methods

Modifier and Type	Method and Description
Column	apply(scala.collection.Seq<Column> exprs)
DataType	dataType()
java.lang.Object	f()
scala.collection.Seq<DataType>	inputTypes()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

UserDefinedFunction

protected UserDefinedFunction(java.lang.Object f,
                   DataType dataType,
                   scala.collection.Seq<DataType> inputTypes)

Method Detail

f

public java.lang.Object f()

dataType

public DataType dataType()

inputTypes

public scala.collection.Seq<DataType> inputTypes()

apply

public Column apply(scala.collection.Seq<Column> exprs)