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

User-Defined Aggregate FunctionsΒΆ

User-defined aggregate functions (UDAFs) in Snowpark. Refer to UDAFRegistration for details and sample code.

Classes

UserDefinedAggregateFunction(handler, name, ...)

Encapsulates a user defined aggregate function that is returned by udaf(), UDAFRegistration.register() or UDAFRegistration.register_from_file().

UDAFRegistration(session)

Provides methods to register lambdas and functions as UDAFs in the Snowflake database.

Methods

describe(udaf_obj)

Returns a DataFrame that describes the properties of a UDAF.

register(handler[, return_type, ...])

Registers a Python function as a Snowflake Python UDAF and returns the UDAF.

register_from_file(file_path, handler_name)

Registers a Python class as a Snowflake Python UDAF from a Python or zip file, and returns the UDAF.

Attributes

handler

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

name

The UDAF name.
Language: English