snowflake.core.function.FunctionResource | Snowflake Documentation (original) (raw)

class snowflake.core.function.FunctionResource(name_with_args: Annotated[str, Strict(strict=True)], collection: FunctionCollection)¶

Bases: SchemaObjectReferenceMixin[FunctionCollection]

Represents a reference to a Snowflake function.

With this function reference, you can create and fetch information about functions, as well as perform certain actions on them.

Attributes

database¶

The DatabaseResource this reference belongs to.

fully_qualified_name¶

Return the fully qualified name of the object this reference points to.

root¶

The Root object this reference belongs to.

Methods

delete(if_exists: bool = False) → None¶

Delete this function.

Parameters:

if_exists (bool , optional) – Whether to error if the function doesn’t exist. Default is False.

Examples

Deleting a function using its reference, erroring if it doesn’t exist:

function_reference.delete()

Deleting a function using its reference, if it exists:

function_reference.delete(if_exists=True) The delete method is deprecated; use drop instead.

drop(if_exists: bool = False) → None¶

Drop this function.

Parameters:

if_exists (bool , optional) – Whether to error if the function doesn’t exist. Default is False.

Examples

Dropping a function using its reference, erroring if it doesn’t exist:

function_reference.drop()

Dropping a function using its reference, if it exists:

function_reference.drop(if_exists=True)

drop_async(if_exists: bool = False) → PollingOperation[None]¶

An asynchronous version of drop().

Refer to PollingOperation for more information on asynchronous execution and the return type.

execute(input_args: list[Any] | None = None) → Any¶

Execute this function.

Parameters:

input_args (list [ Any ] , optional) – A list of arguments to pass to the function. The number of arguments must match the number of arguments the function expects.

Examples

Executing a function using its reference:

function_reference.execute(input_args=[1, 2, "word"])

execute_async(input_args: list[Any] | None = None) → PollingOperation[Any]¶

An asynchronous version of execute().

Refer to PollingOperation for more information on asynchronous execution and the return type.

fetch() → Function¶

Fetch the details of a function.

Examples

Fetching a reference to a function to print its name:

function_reference = root.databases["my_db"].schemas["my_schema"].functions["foo(REAL)"] my_function = function_reference.fetch() print(my_function.name)

fetch_async() → PollingOperation[Function]¶

An asynchronous version of fetch().

Refer to PollingOperation for more information on asynchronous execution and the return type.