handles.DoltHandle

A Dolt revision database: mysql://user@host:port/db/<ref>.

Usage

Source

handles.DoltHandle(
    key,
    read_only,
    url,
    database,
    ref,
    commit=None,
)

ref is a branch (writable) or a tag / commit hash (read-only). Connect with database=handle.database_ref or USE db/ref; the password is never carried in the handle.

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.

url: str

mysql://user@host:port/db/ref (no password).

database: str

Dolt database name.

ref: str

Branch (writable) or tag / commit hash (read-only).

commit: str | None = None

Commit the ref resolved to, when known.

Attributes

Name	Description
database_ref	db/ref, the revision database to USE or connect to.

---

database_ref

db/ref, the revision database to USE or connect to.

database_ref: str