org.apache.spark.sql.expressions

Class UserDefinedFunction

Object

org.apache.spark.sql.expressions.UserDefinedFunction

All Implemented Interfaces:

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

public class UserDefinedFunction
extends Object
implements scala.Product, scala.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")) )
 

Since:

1.3.0

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
Column	apply(Column... exprs) Returns an expression that invokes the UDF, using the given arguments.
Column	apply(scala.collection.Seq<Column> exprs) Returns an expression that invokes the UDF, using the given arguments.
UserDefinedFunction	asNondeterministic() Updates UserDefinedFunction to nondeterministic.
UserDefinedFunction	asNonNullable() Updates UserDefinedFunction to non-nullable.
abstract static boolean	canEqual(Object that)
DataType	dataType()
boolean	deterministic() Returns true iff the UDF is deterministic, i.e.
abstract static boolean	equals(Object that)
Object	f()
scala.Option<scala.collection.Seq<DataType>>	inputTypes()
boolean	nullable() Returns true when the UDF can return a nullable value.
abstract static int	productArity()
abstract static Object	productElement(int n)
static scala.collection.Iterator<Object>	productIterator()
static String	productPrefix()
UserDefinedFunction	withName(String name) Updates UserDefinedFunction with a given name.

Methods inherited from class Object

equals, 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

Method Detail

canEqual

public abstract static boolean canEqual(Object that)

equals

public abstract static boolean equals(Object that)

productElement

public abstract static Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<Object> productIterator()

productPrefix

public static String productPrefix()

apply

public Column apply(Column... exprs)

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

Parameters:

exprs - (undocumented)

Returns:

(undocumented)

Since:

1.3.0

f

public Object f()

dataType

public DataType dataType()

inputTypes

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

nullable

public boolean nullable()

Returns true when the UDF can return a nullable value.

Returns:

(undocumented)

Since:

2.3.0

deterministic

public boolean deterministic()

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

Returns:

(undocumented)

Since:

2.3.0

apply

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

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

Parameters:

exprs - (undocumented)

Returns:

(undocumented)

Since:

1.3.0

withName

public UserDefinedFunction withName(String name)

Updates UserDefinedFunction with a given name.

Parameters:

name - (undocumented)

Returns:

(undocumented)

Since:

2.3.0

asNonNullable

public UserDefinedFunction asNonNullable()

Updates UserDefinedFunction to non-nullable.

Returns:

(undocumented)

Since:

2.3.0

asNondeterministic

public UserDefinedFunction asNondeterministic()

Updates UserDefinedFunction to nondeterministic.

Returns:

(undocumented)

Since:

2.3.0