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, packages: Optional[List[Union[str, module]]] = None)[source] (https://github.com/snowflakedb/snowpark-python/blob/v1.26.0/snowpark-python/src/snowflake/snowpark/udtf.py#L69-L130)

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.

See also

Attributes

handler

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

name

The UDTF name.
Language: English