snowflake.core.event_table.EventTable

class snowflake.core.event_table.EventTable(*, name: Annotated[str, Strict(strict=True)], cluster_by: List[Annotated[str, Strict(strict=True)]] | None = None, data_retention_time_in_days: Annotated[int, Strict(strict=True)] | None = None, max_data_extension_time_in_days: Annotated[int, Strict(strict=True)] | None = None, change_tracking: Annotated[bool, Strict(strict=True)] | None = None, default_ddl_collation: Annotated[str, Strict(strict=True)] | None = None, comment: Annotated[str, Strict(strict=True)] | None = None, 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, owner_role_type: Annotated[str, Strict(strict=True)] | None = None, rows: Annotated[int, Strict(strict=True)] | None = None, bytes: Annotated[int, Strict(strict=True)] | None = None, automatic_clustering: Annotated[bool, Strict(strict=True)] | None = None, search_optimization: Annotated[bool, Strict(strict=True)] | None = None, search_optimization_progress: Annotated[int, Strict(strict=True)] | None = None, search_optimization_bytes: Annotated[int, Strict(strict=True)] | None = None, columns: List[EventTableColumn] | None = None)

Bases: BaseModel

A model object representing the EventTable resource.

Constructs an object of type EventTable with the provided properties.

Parameters:

  • name (str) – Name of the event table

  • cluster_by (List[str], optional) – Cluster key column(s) or expression

  • data_retention_time_in_days (int, optional) – number of days to retain the old version of deleted/updated data

  • max_data_extension_time_in_days (int, optional) – Maximum number of days to extend data retention beyond the retention period to prevent a stream becoming stale.

  • change_tracking (bool, optional) – True if change tracking is enabled, allowing streams and CHANGES to be used on the entity.

  • default_ddl_collation (str, optional) – Collation that is used for all the new columns created by the DDL statements (if not specified)

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

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

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

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

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

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

  • rows (int, optional) – Number of rows in the table.

  • bytes (int, optional) – Number of bytes that will be scanned if the entire table is scanned in a query.Note that this number may be different than the number of actual physical bytes stored on-disk for the table

  • automatic_clustering (bool, optional) – If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the table.

  • search_optimization (bool, optional) – If ON, the table has the search optimization service enabled

  • search_optimization_progress (int, optional) – Percentage of the table that has been optimized for search

  • search_optimization_bytes (int, optional) – Number of additional bytes of storage that the search optimization service consumes for this table

  • columns (List[EventTableColumn], optional)

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) → EventTable

Create an instance of EventTable from a dict.

classmethod from_json(json_str: str) → EventTable

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