snowflake.core.pipe.Pipe

class snowflake.core.pipe.Pipe(*, name: Annotated[str, Strict(strict=True)], comment: Annotated[str, Strict(strict=True)] | None = None, auto_ingest: Annotated[bool, Strict(strict=True)] | None = None, error_integration: Annotated[str, Strict(strict=True)] | None = None, aws_sns_topic: Annotated[str, Strict(strict=True)] | None = None, integration: Annotated[str, Strict(strict=True)] | None = None, copy_statement: Annotated[str, Strict(strict=True)], created_on: datetime | None = None, database_name: Annotated[str, Strict(strict=True)] | None = None, schema_name: Annotated[str, Strict(strict=True)] | None = None, owner: Annotated[str, Strict(strict=True)] | None = None, pattern: Annotated[str, Strict(strict=True)] | None = None, owner_role_type: Annotated[str, Strict(strict=True)] | None = None, invalid_reason: Annotated[str, Strict(strict=True)] | None = None, budget: Annotated[str, Strict(strict=True)] | None = None)

Bases: BaseModel

A model object representing the Pipe resource.

Constructs an object of type Pipe with the provided properties.

Parameters:

  • name (str) – Name of the pipe

  • copy_statement (str) – COPY INTO <table> statement used to load data from queued files into a Snowflake table. This statement serves as the text/definition for the pipe and is displayed in the SHOW PIPES output

  • comment (str, optional) – user comment associated to an object in the dictionary

  • auto_ingest (bool, optional) – TRUE if all files from stage need to be auto-ingested

  • error_integration (str, optional) – Link to integration object that point to a user provided Azure storage queue / SQS. When present, errors (e.g. ingest failure for Snowpipe or a user task failure or replication failure) will be sent to this queue to notify customers

  • aws_sns_topic (str, optional) – Optional, if provided, auto_ingest pipe will only receive messages from this SNS topic.

  • integration (str, optional) – Link to integration object that ties a user provided storage queue to an auto_ingest enabled pipe. Required for auto_ingest to work on azure.

  • created_on (datetime, optional) – Date and time when the pipe was created.

  • database_name (str, optional) – Database in which the pipe is stored

  • schema_name (str, optional) – Schema in which the pipe is stored

  • owner (str, optional) – Role that owns the pipe

  • pattern (str, optional) – PATTERN copy option value in the COPY INTO <table> statement in the pipe definition, if the copy option was specified.

  • owner_role_type (str, optional) – The type of role that owns the pipe

  • invalid_reason (str, optional) – Displays some detailed information for your pipes that may have issues

  • budget (str, optional) – Name of the budget if the pipe is monitored by a budget

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

classmethod from_dict(obj: dict) → Pipe

Create an instance of Pipe from a dict.

classmethod from_json(json_str: str) → Pipe

Create an instance of Pipe from a JSON string.

to_dict(hide_readonly_properties: bool = False) → Dict[str, Any]

Returns the dictionary representation of the model using alias.

to_dict_without_readonly_properties() → Dict[str, Any]

Return the dictionary representation of the model without readonly properties.

to_json() → str

Returns the JSON representation of the model using alias.

to_str() → str

Returns the string representation of the model using alias.

Language: English