class pixeltable.ColumnMetadata

Metadata for a column of a Pixeltable table.

attr comment

comment: str | None

User-provided column comment.

attr computed_with

computed_with: str | None

Expression used to compute this column; None if this is not a computed column.

attr custom_metadata

custom_metadata: Any

User-defined JSON metadata for this column, if any.

attr defined_in

defined_in: str | None

Name of the table where this column was originally defined. If the current table is a view, then defined_in may differ from the current table name.

attr depends_on

depends_on: list[tuple[str, str]] | None

List of dependencies (table name, column name) if this is a computed column, else None.

attr destination

destination: str | None

An object store reference for computed files, if one is configured.

attr is_builtin

is_builtin: bool | None

If False, this computed column makes calls to custom UDFs; None if this is not a computed column.

attr is_computed

is_computed: bool

True if this column is a computed column.

attr is_iterator_col

is_iterator_col: bool

True if this column is produced by an iterator (only applicable to views).

attr is_primary_key

is_primary_key: bool

True if this column is part of the table’s primary key.

attr is_stored

is_stored: bool

True if this is a stored column; False if it is dynamically computed.

attr media_validation

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

The media validation policy for this column. None if the type of this column is not a media type.

attr name

name: str

The name of the column.

attr type_

type_: str

The type specifier of the column.

attr version_added

version_added: int

The table version when this column was added.

SDK Reference

​class pixeltable.ColumnMetadata

​attr comment

​attr computed_with

​attr custom_metadata

​attr defined_in

​attr depends_on

​attr destination

​attr is_builtin

​attr is_computed

​attr is_iterator_col

​attr is_primary_key

​attr is_stored

​attr media_validation

​attr name

​attr type_

​attr version_added