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

class snowflake.core.stream.StreamSource(*, name: Annotated[str, Strict(strict=True)], database_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None, schema_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True)])] | None = None)¶

Bases: BaseModel

A model object representing the StreamSource resource.

Constructs an object of type StreamSource with the provided properties.

Parameters:

• name (str) – Name of the source whose changes are tracked by the stream
• database_name (str , optional) – Database name to which stream source type belongs. If not provided, database name provided in the path param will be used.
• schema_name (str , optional) – Schema name to which stream source type belongs. If not provided, schema name provided in the path param will be used.

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) → StreamSourceExternalTable | StreamSourceStage | StreamSourceTable | StreamSourceView¶

Create an instance of StreamSource from a dict.

classmethod from_json(json_str: str) → StreamSourceExternalTable | StreamSourceStage | StreamSourceTable | StreamSourceView¶

Create an instance of StreamSource 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.