snowflake.core.pipe.PipeResource¶

class snowflake.core.pipe.PipeResource(name: str, collection_class: PipeCollectionBase)¶

Bases: PipeResourceBase

Represents a reference to a Snowflake pipe.

With this pipe reference, you can fetch information about pipes, 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¶

Delete a pipe.

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

Fetch a pipe.

fetch_async() → PollingOperation[Pipe]¶

An asynchronous version of fetch().

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

refresh(if_exists: bool | None = None, prefix: str | None = None, modified_after: datetime | None = None) → None¶

Refresh the pipe.

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.

  • prefix (str) – Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load.

  • modified_after (datetime) – Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)

refresh_async(if_exists: bool | None = None, prefix: str | None = None, modified_after: datetime | None = None) → PollingOperation[None]¶

An asynchronous version of refresh().

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

Language: English