snowflake.core.catalog_integration.CatalogIntegrationResource¶

class snowflake.core.catalog_integration.CatalogIntegrationResource(name: Annotated[str, Strict(strict=True)], collection: CatalogIntegrationCollection)¶

Bases: ObjectReferenceMixin[CatalogIntegrationCollection]

Represents a reference to a Snowflake Catalog Integration resource.

With this catalog integration reference, you can create, update, and fetch information about catalog integrations, as well as perform certain actions on them.

Attributes

root¶

The Root object this reference belongs to.

Methods

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

Drop this catalog integration.

Parameters:

if_exists (bool, optional) – Check the existence of this catalog integration before dropping it. Default is None, which is equivalent to False.

Examples

Deleting a catalog integration using its reference:

>>> catalog_integration_reference.drop()
Copy

Deleting a catalog integration using its reference if it exists:

>>> catalog_integration_reference.drop(if_exists = True)
Copy
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.

fetch() → CatalogIntegration¶

Fetch the details of a catalog integration.

Examples

Fetching a catalog integration reference to print its time of creation:

>>> print(catalog_integration_reference.fetch().created_on)
Copy
fetch_async() → PollingOperation[CatalogIntegration]¶

An asynchronous version of fetch().

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

Language: English