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

Scalar Builtin UDF Registration Parameters

The purpose of registering a Scalar Builtin UDF is to obtain the handle of an existing function in the database, with no actual registration operation performed.

Whether it is explicit or implicit registration, for registering a Builtin-type Scalar UDF, you can currently pass the following parameters:

Table 1 Scalar Builtin UDF registration parameters

Registration Parameter

Description

Type

Default Value

name

Specifies the actual storage name of the UDF in the database.

str | None

None

database

Specifies the LakeFormation database where the UDF resides.

str | None

None

fn

Specifies the original Python function of the UDF.

Callable

None

signature (currently unavailable)

Specifies the UDF function signature and return value type.

ibis.common.annotations.Signature | None

None

Notes:

For the signature parameter, user input is currently not allowed. Only automatic inference of parameter/return value types is supported. See Type Inference of the signature Parameter for details.