snowflake.core.stream.StreamResource

class snowflake.core.stream.StreamResource(name: str, collection_class: StreamCollectionBase)

Bases: StreamResourceBase

Represents a reference to a Snowflake Stream resource.

With this stream reference, you can fetch information about a stream, 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

clone(target_database: str, target_schema: str, stream_clone: StreamClone, create_mode: CreateMode | str | None = None, copy_grants: bool | None = None) → None

Clone a stream.

Parameters:

  • target_database (str) – Database of the target resource. Defaults to the source’s database (required)

  • target_schema (str) – Schema of the target resource. Defaults to the source’s schema (required)

  • stream_clone (StreamClone) – (required)

  • create_mode (Union[CreateMode, str]) – Parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

  • copy_grants (bool) – Parameter to enable copy grants when creating the object.

clone_async(target_database: str, target_schema: str, stream_clone: StreamClone, create_mode: CreateMode | str | None = None, copy_grants: bool | None = None) → PollingOperation[None]

An asynchronous version of clone().

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

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

Delete a stream.

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.

fetch() → Stream

Fetch a stream.

fetch_async() → PollingOperation[Stream]

An asynchronous version of fetch().

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

Language: English