handles.FileHandle

A plain file or object-store artifact (always read-only).

Usage

Source

handles.FileHandle(
    key,
    read_only,
    uri,
    version_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.

uri: str

Local path or object URI (s3://, gs://, az://, …).

version_id: str | None = None

Object-store version id when opened at a versioned state.