class pixeltable.types.ColumnSpec

Column specification, a dictionary representation of a column’s schema. Exactly one of type or value must be included in the dictionary.

attr comment

comment: str

Optional comment for the column. Displayed in .describe() output.

custom_metadata: Any

User-defined metadata to associate with the column.

destination: str | Path

Destination for storing computed output files. Only applicable for computed columns. Can be:

media_validation: Literal['on_read', 'on_write']

When to validate media; 'on_read' or 'on_write'.

primary_key: bool

Whether this column is part of the primary key. Defaults to False.

stored: bool

Whether to store the column data. Defaults to True.

type: type

The column type (e.g., pxt.Image, str). Required unless value is specified.

value: exprs.Expr

A Pixeltable expression for computed columns. Mutually exclusive with type.