將 Python 函式（包括 lambda 函式）或使用者自訂函式註冊為 SQL 函式。
語法
register(name, f, returnType=None)
參數
| 參數 | 類型 | 說明 |
|---|---|---|
name |
str | SQL 語句中使用者定義函式的名稱。 |
f |
函數， udf或 pandas_udf |
Python 函式，或使用者自訂函式。 使用者自訂函數可以是逐列或向量化。 |
returnType |
DataType 或 str，選用 | 註冊的使用者定義函式的回傳類型。 可以是 DataType 物件或 DDL 格式的型態字串。 僅在 f 是純 Python 函數時有效，當 f 已經是使用者定義函數時不適用。 |
退貨
函式
Notes
要註冊一個非確定性Python函數，首先為該Python函數建立一個非確定性的使用者定義函數，然後將其註冊為 SQL 函式。
Examples
# Register a lambda as a SQL function (return type defaults to string).
strlen = spark.udf.register("stringLengthString", lambda x: len(x))
spark.sql("SELECT stringLengthString('test')").collect()
# [Row(stringLengthString(test)='4')]
spark.sql("SELECT 'foo' AS text").select(strlen("text")).collect()
# [Row(stringLengthString(text)='3')]
# Register with an explicit return type.
from pyspark.sql.types import IntegerType
spark.udf.register("stringLengthInt", lambda x: len(x), IntegerType())
spark.sql("SELECT stringLengthInt('test')").collect()
# [Row(stringLengthInt(test)=4)]
# Register an existing UDF.
from pyspark.sql.functions import udf
slen = udf(lambda s: len(s), IntegerType())
spark.udf.register("slen", slen)
spark.sql("SELECT slen('test')").collect()
# [Row(slen(test)=4)]
# Register a nondeterministic UDF.
import random
random_udf = udf(lambda: random.randint(0, 100), IntegerType()).asNondeterministic()
spark.udf.register("random_udf", random_udf)
# Register a pandas UDF.
import pandas as pd
from pyspark.sql.functions import pandas_udf
@pandas_udf("integer")
def add_one(s: pd.Series) -> pd.Series:
return s + 1
spark.udf.register("add_one", add_one)
spark.sql("SELECT add_one(id) FROM range(3)").collect()
# [Row(add_one(id)=1), Row(add_one(id)=2), Row(add_one(id)=3)]
# Register a grouped aggregate pandas UDF.
@pandas_udf("integer")
def sum_udf(v: pd.Series) -> int:
return v.sum()
spark.udf.register("sum_udf", sum_udf)
spark.sql(
"SELECT sum_udf(v1) FROM VALUES (3, 0), (2, 0), (1, 1) tbl(v1, v2) GROUP BY v2"
).sort("sum_udf(v1)").collect()
# [Row(sum_udf(v1)=1), Row(sum_udf(v1)=5)]