sddb.Dataset

class sddb.Dataset(row: Series)

One catalog row: a published dataset. Column values are exposed as attributes.

Methods table

elements()	Return element shapes/dtypes without loading data.
resolve(roles)	Resolve role regexes to this store's element paths ("kind/name"); see sddb.resolve().
to_sdata(*[, elements, dest])	Open this dataset as SpatialData, fetched and cached like SpatialDataCohort.to_list().
view()	Open viewer_url() in the default browser.
view_interactive(*[, mode])	In-notebook interactive view; requires the [viz] extra.
viewer_url()	Build a vitessce.io viewer link from this row's vitessce_url (pure string transform).

Methods

elements() → dict[str, dict[str, Any]]

Return element shapes/dtypes without loading data.

resolve(roles: Mapping[str, str]) → dict[str, str]

Resolve role regexes to this store's element paths ("kind/name"); see sddb.resolve().

to_sdata(*, elements: list[str] | None = None, dest: str | Path | None = None) → SpatialData

Open this dataset as SpatialData, fetched and cached like SpatialDataCohort.to_list().

A remote store is copied once into the cache (keyed by full uid) and reused; a local store opens in place. dest keeps the store in dest/<uid>.zarr (the download() layout); elements ("kind/name") copies only those elements. Both together copy only those elements into dest/<uid>.zarr and record them in dest/manifest.json as a "partial" entry; a later download(dest) fetches the whole store. If dest already holds the complete store, elements opens it whole.

view() → None

Open viewer_url() in the default browser.

Raises:

ValueError -- If the row has no vitessce_url, or its link loads another dataset's store (with the warning from viewer_url()).

view_interactive(*, mode: str = 'config') → Any

In-notebook interactive view; requires the [viz] extra.

mode="config" renders the published Vitessce config (vitessce_url); mode="sdata" loads the store and renders it via easy_vitessce.

Raises:

ValueError -- With mode="config", if the row has no vitessce_url or its link loads another dataset's store (with the warning from viewer_url()).

viewer_url() → str | None

Build a vitessce.io viewer link from this row's vitessce_url (pure string transform).

If vitessce_url is already a vitessce.io viewer link (as in the published catalog) it is returned unchanged. Otherwise it is treated as a config-sidecar URL: an s3://bucket/key URL is rewritten to the LaminHub CORS proxy https://lamin.ai/storage/s3/bucket/key and wrapped as https://vitessce.io/?url=<proxied>.

Some published links load another dataset's store (333 of 6087 rows in the 2026-10-28 catalog). The store id in the link (.lamindb/<id>.zarr) is compared with the one in zarr_url, and on a mismatch the link is hidden: this returns None with a warning, as the website does.

Warns:

UserWarning -- If the link loads another dataset's store.

Raises:

ValueError -- If the row has no vitessce_url.