TableMetadata

pixeltable.TableMetadata

Metadata for a Pixeltable table.

base instance-attribute

base: Optional[str]

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

columns instance-attribute

columns: dict[str, ColumnMetadata]

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

comment instance-attribute

comment: Optional[str]

User-provided table comment, if one exists.

indices instance-attribute

indices: dict[str, IndexMetadata]

Index metadata for all of the indices of the table.

is_replica instance-attribute

is_replica: bool

True if this table is a replica of another (shared) table.

is_snapshot instance-attribute

is_snapshot: bool

True if this table is a snapshot.

is_view instance-attribute

is_view: bool

True if this table is a view.

media_validation instance-attribute

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

The media validation policy for this table.

name instance-attribute

name: str

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

path instance-attribute

path: str

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

schema_version instance-attribute

schema_version: int

The current schema version of the table.

version instance-attribute

version: int

The current version of the table.

version_created instance-attribute

version_created: datetime

The timestamp when this table version was created.