snowflake.core.table.Table

class snowflake.core.table.Table(*, name: Annotated[str, Strict(strict=True)], kind: Annotated[str, Strict(strict=True)] | None = 'PERMANENT', cluster_by: List[Annotated[str, Strict(strict=True)]] | None = None, enable_schema_evolution: Annotated[bool, Strict(strict=True)] | None = None, change_tracking: Annotated[bool, 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, default_ddl_collation: Annotated[str, Strict(strict=True)] | None = None, columns: List[TableColumn] | None = None, constraints: List[Constraint] | 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, rows: Annotated[int, Strict(strict=True)] | None = None, bytes: Annotated[int, Strict(strict=True)] | None = None, owner: Annotated[str, Strict(strict=True)] | None = None, dropped_on: datetime | 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, owner_role_type: Annotated[str, Strict(strict=True)] | None = None, budget: Annotated[str, Strict(strict=True)] | None = None, table_type: Annotated[str, Strict(strict=True)] | None = None)

Bases: BaseModel

A model object representing the Table resource.

Constructs an object of type Table with the provided properties.

Parameters:

  • name (str) – Specifies the name for the table, must be unique for the schema in which the table is created

  • kind (str, default 'PERMANENT') – Table type - permanent, transient, or temporary

  • cluster_by (list[str], optional) – Specifies one or more columns or column expressions in the table as the clustering key

  • enable_schema_evolution (bool, optional) – Table has schema evolution enabled or disabled

  • change_tracking (bool, optional) – Change tracking is enabled or disabled

  • data_retention_time_in_days (int, optional) – Specifies the retention period for the table so that Time Travel actions SELECT, CLONE, UNDROP can be performed on historical data in the table

  • max_data_extension_time_in_days (int, optional) – Specifies the retention period for the table so that Time Travel actions SELECT, CLONE, UNDROP can be performed on historical data in the table

  • default_ddl_collation (str, optional) – Specifies a default collation specification for the columns in the table, including columns added to the table in the future

  • columns (list[TableColumn], optional)

constraints : list[Constraint], optional

commentstr, optional

Comment for the table

created_ondatetime, optional

Date and time when the table was created.

database_namestr, optional

Database in which the table is stored

schema_namestr, optional

Schema in which the table is stored

rowsint, optional

Number of rows in the table. Returns NULL for external tables.

bytesint, 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

ownerstr, optional

Role that owns the table

dropped_ondatetime, optional

Date and time when the table was dropped

automatic_clusteringbool, optional

If Automatic Clustering is enabled for your account, specifies whether it is explicitly enabled or disabled for the table.

search_optimizationbool, optional

If ON, the table has the search optimization service enabled

search_optimization_progressint, optional

Percentage of the table that has been optimized for search.

search_optimization_bytesint, optional

Number of additional bytes of storage that the search optimization service consumes for this table

owner_role_typestr, optional

The type of role that owns the object.

budgetstr, optional

Name of the budget if the object is monitored by a budget

table_typestr, optional

Type of the table

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

Create an instance of Table from a dict.

classmethod from_json(json_str: str) → Table

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