snowflake.core.table.TableColumn | Snowflake Documentation (original) (raw)

class snowflake.core.table.TableColumn(*, name: Annotated[str, Strict(strict=True)], datatype: Annotated[str, Strict(strict=True)], nullable: Annotated[bool, Strict(strict=True)] | None = True, collate: Annotated[str, Strict(strict=True)] | None = None, default: Annotated[str, Strict(strict=True)] | None = None, autoincrement: Annotated[bool, Strict(strict=True)] | None = None, autoincrement_start: Annotated[int, Strict(strict=True)] | None = None, autoincrement_increment: Annotated[int, Strict(strict=True)] | None = None, constraints: List[Constraint] | None = None, comment: Annotated[str, Strict(strict=True)] | None = None)¶

Bases: BaseModel

A model object representing the TableColumn resource.

Constructs an object of type TableColumn with the provided properties.

Parameters:

• name (str) – Column name
• datatype (str) – The data type for the column
• nullable (bool , default True) – Specifies that the column does allow NULL values or not.
• collate (str , optional) – Specifies the collation to use for column operations such as string comparison
• default (str , optional) – Specifies whether a default value is automatically inserted in the column if a value is not explicitly specified via an INSERT or CREATE TABLE AS SELECT statement
• autoincrement (bool , optional)
• autoincrement_start (int , optional) – The default value for the column starts with the specified number
• autoincrement_increment (int , optional) – Each successive value for the column automatically increments by the specified amount
• constraints (List _[_Constraint] , optional)
• comment (str , optional) – Specifies a comment for the column

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

Create an instance of TableColumn from a dict.

classmethod from_json(json_str: str) → TableColumn¶

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