Updated on 2025-08-25 GMT+08:00

Scalar UDF Explicit Registration Syntax

Explicit registration means you need to manually add registration logic code intrusively in Python code, using backend...register or register_from_file to achieve it, where calling equals registering. Explicit registration depends on having already obtained the backend session object before proceeding.

Scenarios recommending explicit registration: If you wish to explicitly control registration timing, allow intrusive addition of registration logic, or require separation of Scalar UDF registration and usage under the same backend connection.

A typical scenario involves one development team being responsible for UDF registration while multiple teams handle UDF usage, with no communication between the Python scripts of the registration and usage teams.

Table 1 Explicit registration syntax

UDF Type

UDF Type (Secondary)

Registration Type (Tertiary)

Code Entry

Helpful Link

udf

python

Direct registration

backend.udf.python.register(<Registration function>, <Registration parameters>)

Scalar Python UDF Registration Parameters

File-based registration

backend.udf.python.register_from_file(<File path>, <Function name>, <Registration parameters>)

Scalar Python UDF Registration Parameters

builtin

Direct registration

backend.udf.builtin.register(<Registration function>, <Registration parameters>)

Scalar Builtin UDF Registration Parameters

File-based registration

backend.udf.builtin.register_from_file(<File path>, <Function name>, <Registration parameters>)

Scalar Builtin UDF Registration Parameters