You are viewing documentation about an older version (1.11.1). View latest version

snowflake.snowpark.udtf.UserDefinedTableFunction

class snowflake.snowpark.udtf.UserDefinedTableFunction(handler: Union[Callable, Tuple[str, str]], output_schema: Union[StructType, Iterable[str], PandasDataFrameType], input_types: List[DataType], name: str)[source]

Bases: object

Encapsulates a user defined table function that is returned by udtf(), UDTFRegistration.register() or UDTFRegistration.register_from_file(). The constructor of this class is not supposed to be called directly.

Call an instance of UserDefinedTableFunction to generate a TableFunctionCall instance. The input type can be a column name as a str, or a Column object.

Attributes

handler

The Python class or a tuple containing the Python file path and the function name.

name

The UDTF name.