snowflake.core.stage.StageDirectoryTable¶

class snowflake.core.stage.StageDirectoryTable(*, enable: Annotated[bool, Strict(strict=True)] | None = False, refresh_on_create: Annotated[bool, Strict(strict=True)] | None = True, auto_refresh: Annotated[bool, Strict(strict=True)] | None = False, notification_integration: Annotated[str, Strict(strict=True)] | None = None)¶

Bases: BaseModel

A model object representing the StageDirectoryTable resource.

Constructs an object of type StageDirectoryTable with the provided properties.

Parameters:

• enable (bool, default False) – Specifies whether to add a directory table to the stage. When the value is TRUE, a directory table is created with the stage.

• refresh_on_create (bool, default True) – Specifies whether to automatically refresh the directory table metadata once, immediately after the stage is created.

• auto_refresh (bool, default False) – Specifies whether Snowflake should enable triggering automatic refreshes of the directory table metadata when new or updated data files are available in the named external stage specified in the URL value.

• notification_integration (str, optional) – Specifies the name of the notification integration used to automatically refresh the directory table metadata.

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) → StageDirectoryTable¶

Create an instance of StageDirectoryTable from a dict.

classmethod from_json(json_str: str) → StageDirectoryTable¶

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