snowflake.core.stream.StreamResource | Snowflake Documentation (original) (raw)

class snowflake.core.stream.StreamResource(name: Annotated[str, Strict(strict=True)], collection: StreamCollection)¶

Bases: SchemaObjectReferenceMixin[StreamCollection]

Represents a reference to a Snowflake Stream resource.

With this stream reference, you can create, update, and fetch information about streams, 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

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

Drop this stream.

Parameters:

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

Examples

Deleting a stream using its reference:

stream_reference.drop()

Deleting a stream using its reference if it exists:

stream_reference.drop(if_exists = True)

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() → Stream ¶

Fetch the details of a stream.

Examples

Fetching a stream reference to print its time of creation:

print(stream_reference.fetch().created_on)

An asynchronous version of fetch().

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