class pixeltable.TableMetadata

Metadata for a Pixeltable table.

attr base

base: str | None

If this table is a view or snapshot, the full path of its base table; otherwise None.

attr columns

columns: dict[str, ColumnMetadata]

Column metadata for all of the visible columns of the table.

attr comment

comment: str | None

User-provided table comment, if one exists.

attr custom_metadata

custom_metadata: Any

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

attr has_default_idxs

has_default_idxs: bool

True if eligible columns of this table get a default B-tree index.

attr id

id: uuid.UUID

The stable UUID of the table. Useful for detecting drop-and-recreate across time.

attr indexes

indexes: dict[str, IndexMetadata]

Index metadata for all of the indexes of the table.

attr is_data_versioned

is_data_versioned: bool

True if this is a data-versioned table.

attr is_snapshot

is_snapshot: bool

True if this table is a snapshot.

attr is_view

is_view: bool

True if this table is a view.

attr iterator_call

iterator_call: str | None

The iterator call for views that use an iterator; otherwise None.

attr kind

kind: Literal['table', 'view', 'snapshot']

The kind of table: 'table', 'view', or 'snapshot'.

attr media_validation

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

The media validation policy for this table.

attr name

name: str

The name of the table (ex: 'my_table').

attr path

path: str

The full path of the table (ex: 'my_dir.my_subdir.my_table').

attr primary_key

primary_key: list[str] | None

List of primary key column names, or None if this table has no primary key.

attr schema_version

schema_version: int

The current schema version of the table.

attr version

version: int | None

The current version of the table or None if it’s not data-versioned.

attr version_created

version_created: datetime.datetime

The timestamp when this table version was created.

attr view_filter

view_filter: str | None

A display string of a view’s filter (where) predicate; None if this is not a view or has no filter.

attr view_sample

view_sample: str | None

A display string of a view’s sample clause; None if this is not a view or has no sample clause.

​class pixeltable.TableMetadata

​attr base

​attr columns

​attr comment

​attr custom_metadata

​attr has_default_idxs

​attr id

​attr indexes

​attr is_data_versioned

​attr is_snapshot

​attr is_view

​attr iterator_call

​attr kind

​attr media_validation

​attr name

​attr path

​attr primary_key

​attr schema_version

​attr version

​attr version_created

​attr view_filter

​attr view_sample