UserDefinedTableFunction

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

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

Sintaxe

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 como um StructType ou Nenhum, se não especificado.

Methods

Método	Descrição
asDeterministic()	Atualiza o UserDefinedTableFunction para determinístico.

Observações

Essa API está evoluindo.

Exemplos

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()

+---+---+
| c1| c2|
+---+---+
|  1|  2|
+---+---+

_ = spark.udtf.register(name="plus_one", f=PlusOne)
spark.sql("SELECT * FROM plus_one(1)").collect()

[Row(c1=1, c2=2)]

spark.sql("SELECT * FROM VALUES (0, 1), (1, 2) t(x, y), LATERAL plus_one(x)").collect()

[Row(x=0, y=1, c1=0, c2=1), Row(x=1, y=2, c1=1, c2=2)]