Skip to main content

​
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  indices

indices: dict[str, IndexMetadata]
Index metadata for all of the indices of the table.

​
attr  is_replica

is_replica: bool
True if this table is a replica of another (shared) 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  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  schema_version

schema_version: int
The current schema version of the table.

​
attr  version

version: int
The current version of the table.

​
attr  version_created

version_created: datetime.datetime
The timestamp when this table version was created.