snowflake.core.user_defined_function.SQLFunction

class snowflake.core.user_defined_function.SQLFunction(*, called_on_null_input: Annotated[bool, Strict(strict=True)] | None = None, is_volatile: Annotated[bool, Strict(strict=True)] | None = None)

Bases: FunctionLanguage

A model object representing the SQLFunction resource.

Constructs an object of type SQLFunction with the provided properties.

Parameters:

  • called_on_null_input (bool, optional) – Decide if the function/procedure can receive null input

  • is_volatile (bool, optional) –

    Specifies the behavior of the UDF when returning results. This Field is deprecated for Procedure.

    If true, UDF might return different values for different rows, even for the same input. This field is deprecated for Procedure.

    If false, UDF assumes that the function, when called with the same inputs, will always return the same result. This guarantee is not checked. Specifying IMMUTABLE for a UDF that returns different values for the same input will result in undefined behavior.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

classmethod from_dict(obj: dict) → SQLFunction

Create an instance of SQLFunction from a dict.

classmethod from_json(json_str: str) → SQLFunction

Create an instance of SQLFunction from a JSON string.

to_dict(hide_readonly_properties: bool = False) → Dict[str, Any]

Returns the dictionary representation of the model using alias.

to_dict_without_readonly_properties() → Dict[str, Any]

Return the dictionary representation of the model without readonly properties.

to_json() → str

Returns the JSON representation of the model using alias.

to_str() → str

Returns the string representation of the model using alias.

Language: English