Pular para o conteúdo principal

Função de tabela definida pelo usuário

Uma função de tabela definida pelo usuário em Python.

O construtor desta classe não deve ser chamado diretamente. Use pyspark.sql.functions.udtf para criar uma instância.

Sintaxe

Python
from pyspark.sql.functions import udtf

@udtf(returnType="c1: int, c2: int")
class MyUDTF:
def eval(self, x: int):
yield x, x + 1

Propriedades

Propriedade

Descrição

returnType

O tipo de retorno da função de tabela definida pelo usuário é um StructType ou None, caso não seja especificado.

Métodos

Método

Descrição

asDeterministic()

Atualiza a UserDefinedTableFunction para determinística.

Notas

Esta API está em constante evolução.

Exemplos

Python
from pyspark.sql.functions import lit, udtf

@udtf(returnType="c1: int, c2: int")
class PlusOne:
def eval(self, x: int):
yield x, x + 1

PlusOne(lit(1)).show()
Output
+---+---+
| c1| c2|
+---+---+
| 1| 2|
+---+---+
Python
_ = spark.udtf.register(name="plus_one", f=PlusOne)
spark.sql("SELECT * FROM plus_one(1)").collect()
Output
[Row(c1=1, c2=2)]
Python
spark.sql("SELECT * FROM VALUES (0, 1), (1, 2) t(x, y), LATERAL plus_one(x)").collect()
Output
[Row(x=0, y=1, c1=0, c2=1), Row(x=1, y=2, c1=1, c2=2)]