Python関数 (ラムダ関数を含む) またはユーザー定義関数を SQL 関数として登録します。
構文
register(name, f, returnType=None)
パラメーター
| パラメーター | タイプ | 説明 |
|---|---|---|
name |
str | SQL ステートメントのユーザー定義関数の名前。 |
f |
関数、 udf、または pandas_udf |
Python関数、またはユーザー定義関数。 ユーザー定義関数は、一度に行にすることも、ベクター化することもできます。 |
returnType |
DataType または str(省略可能) | 登録済みのユーザー定義関数の戻り値の型。
DataType オブジェクトまたは DDL 形式の型文字列を指定できます。
f がプレーンなPython関数である場合にのみ有効です。f が既にユーザー定義関数である場合は有効ではありません。 |
返品
関数
メモ
非決定的なPython関数を登録するには、まず、Python関数の非決定的ユーザー定義関数をビルドしてから、SQL 関数として登録します。
例示
# 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)]