handles.IcebergHandle

A pyiceberg table positioned at a branch (write) or tag (read).

Usage

Source

handles.IcebergHandle(
    key,
    read_only,
    table,
    ref=None,
    snapshot_id=None,
)

Parameter Attributes

key: str

A short native label for display: the store’s URI, path, repository, or database – or, for a branch-addressed system such as Neon, the branch the handle opens. Not an identity: two handles on one store may carry different keys, and the engine never compares handles by it. Use the typed fields (uri, path, branch, snapshot_id, …) for anything that matters.

read_only: bool

Whether writes through this handle are allowed.

table: Any

The pyiceberg.table.Table.

ref: str | None = None

Branch or tag name.

snapshot_id: int | None = None

Snapshot id when opened at a recorded state.