Documentation Index
Fetch the complete documentation index at: https://docs.pixeltable.com/llms.txt
Use this file to discover all available pages before exploring further.
class pixeltable.TableMetadata
Metadata for a Pixeltable table.
attr base
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.
User-provided table comment, if one exists.
User-defined JSON metadata for this table, if any.
attr id
The stable UUID of the table. Useful for detecting drop-and-recreate across time.
attr indices
indices: dict[str, IndexMetadata]
Index metadata for all of the indices of the table.
attr is_replica
True if this table is a replica of another (shared) table.
attr is_snapshot
True if this table is a snapshot.
attr is_versioned
True if this is a versioned table.
attr is_view
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', 'replica']
The kind of table: 'table', 'view', 'snapshot', or 'replica'.
media_validation: Literal['on_read', 'on_write']
The media validation policy for this table.
attr name
The name of the table (ex: 'my_table').
attr path
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
The current schema version of the table.
attr version
The current version of the table or None if it’s not versioned.
attr version_created
version_created: datetime.datetime
The timestamp when this table version was created.