snowflake.core.image_repository.ImageRepositoryResource

class snowflake.core.image_repository.ImageRepositoryResource(name: str, collection: ImageRepositoryCollection)

Bases: SchemaObjectReferenceMixin[ImageRepositoryCollection]

Represents a reference to a Snowflake image repository.

With this image repository reference, you can create and fetch information about image repositories, 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() → None

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

Delete this image repository.

Deleting an image repository using its reference:

>>> image_repository_reference.delete()
Copy
drop(if_exists: bool | None = None) → None

Drop this image repository.

Parameters:

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

Examples

Deleting an image repository using its reference:

>>> image_repository_reference.drop()
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() → ImageRepositoryModel

Fetch the details of an image repository.

Examples

Fetching a reference to an image repository to print its name and properties:

>>> my_image_repository = image_repository_reference.fetch()
>>> print(my_image_repository.name)
Copy
fetch_async() → PollingOperation[ImageRepositoryModel]

An asynchronous version of fetch().

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

list_images_in_repository() → Iterator[Image]

List the images in an image repository.

Examples

Listing images in an image repository using an image repository reference:

>>> for image in image_repository_reference.list_images_in_repository():
...     print(image.name)
Copy
list_images_in_repository_async() → PollingOperation[Iterator[Image]]

An asynchronous version of list_images_in_repository().

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

Language: English