Updated on 2025-09-18 GMT+08:00

Scalar UDF Direct Operation Syntax

In scenarios where registration and usage are separate, the Scalar UDF direct operation syntax is provided for users. Users only need to know the UDF name (name) and the database name (database) where the UDF resides to directly use the UDF. The following operations rely on the backend session object.

Table 1 Scalar UDF direct operation syntax

Code Entry

Parameter

Description

Return Value Type

backend.udf.signature

name: str, database: str

Returns the function signature and return value type of the UDF from the backend database.

ibis.common.annotations.Signature

backend.udf.get

name: str, database: str

Returns the UDF operator from the backend database.

Callable[..., ibis.expr.types.Value]

backend.udf.names

database: str

Returns all UDF names from the backend database.

List[str]

backend.udf.unregister

name: str, database: str

Deletes a specified UDF from the backend database.

None