snowflake.core.function.FunctionResource

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

Bases: FunctionResourceBase

Represents a reference to a Snowflake function.

With this function reference, you can fetch information about a function, as well as perform certain actions on it.

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

The delete() method is deprecated; use drop() instead.

drop(if_exists: bool | None = None) → None

Delete a function.

Parameters:

if_exists (bool) – Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist.

drop_async(if_exists: bool | None = None) → 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"])
Copy
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 a Function.

fetch_async() → PollingOperation[Function]

An asynchronous version of fetch().

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

get_tags(with_lineage: bool | None = None) → dict[TagResource, TagValue]

Get the tag assignments for a function.

Returns all tags assigned to a function. This operation requires an active warehouse.

Parameters:

with_lineage (bool) – Parameter that specifies whether tag assignments inherited by the object from its ancestors in securable object hierarchy should be returned as well: - true: All tags assigned to this object should be returned, inheritance included. - false: Only tags explicitly assigned to this object should be returned.

get_tags_async(with_lineage: bool | None = None) → PollingOperation[dict[TagResource, TagValue]]

An asynchronous version of get_tags().

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

set_tags(tags: dict[TagResource, TagValue], if_exists: bool | None = None) → None

Set tags on a function.

Parameters:

  • tags (dict[TagResource, TagValue]) – (required)

  • if_exists (bool) – Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist.

set_tags_async(tags: dict[TagResource, TagValue], if_exists: bool | None = None) → PollingOperation[None]

An asynchronous version of set_tags().

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

unset_tags(tag_resources: set[TagResource], if_exists: bool | None = None) → None

Unset tags from a function.

Parameters:

  • tag_resources (set[TagResource]) – (required)

  • if_exists (bool) – Parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn’t exist.

unset_tags_async(tag_resources: set[TagResource], if_exists: bool | None = None) → PollingOperation[None]

An asynchronous version of unset_tags().

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

Language: English