Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SPARK-23122][PYSPARK][FOLLOW-UP] Update the docs for UDF Registration #20348

Closed
wants to merge 2 commits into from
Closed

[SPARK-23122][PYSPARK][FOLLOW-UP] Update the docs for UDF Registration #20348

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91ea1f5
update the doc.
gatorsmile Jan 22, 2018
73a493a
update the doc.
gatorsmile Jan 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions python/pyspark/sql/udf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,8 +199,8 @@ def __init__(self, sparkSession):
@ignore_unicode_prefix
@since("1.3.1")
def register(self, name, f, returnType=None):
"""Registers a Python function (including lambda function) or a user-defined function
in SQL statements.
"""Register a Python function (including lambda function) or a user-defined function
as a SQL function.

:param name: name of the user-defined function in SQL statements.
:param f: a Python function, or a user-defined function. The user-defined function can
Expand All @@ -210,6 +210,10 @@ def register(self, name, f, returnType=None):
be either a :class:`pyspark.sql.types.DataType` object or a DDL-formatted type string.
:return: a user-defined function.

To register a nondeterministic Python function, users need to first build
a nondeterministic user-defined function for the Python function and then register it
as a SQL function.

`returnType` can be optionally specified when `f` is a Python function but not
when `f` is a user-defined function. Please see below.

Expand Down Expand Up @@ -297,7 +301,7 @@ def register(self, name, f, returnType=None):
@ignore_unicode_prefix
@since(2.3)
def registerJavaFunction(self, name, javaClassName, returnType=None):
"""Register a Java user-defined function so it can be used in SQL statements.
"""Register a Java user-defined function as a SQL function.

In addition to a name and the function itself, the return type can be optionally specified.
When the return type is not specified we would infer it via reflection.
Expand Down Expand Up @@ -334,7 +338,7 @@ def registerJavaFunction(self, name, javaClassName, returnType=None):
@ignore_unicode_prefix
@since(2.3)
def registerJavaUDAF(self, name, javaClassName):
"""Register a Java user-defined aggregate function so it can be used in SQL statements.
"""Register a Java user-defined aggregate function as a SQL function.

:param name: name of the user-defined aggregate function
:param javaClassName: fully qualified name of java class
Expand Down