lamindb.QueryDB

class lamindb.QueryDB(instance)

Bases: object

Query any registry of any instance.

QueryDB exposes all available registries of LaminDB and modules like Bionty or Wetlab.

Parameters:

instance (str) – Instance identifier in format “account/instance”.

Examples

Query records from an instance:

cxg = ln.QueryDB("laminlabs/cellxgene")

artifacts = cxg.Artifact.filter(suffix=".h5ad")
records = cxg.Record.filter(name__startswith="cell")

ECL = cxg.bionty.CellType.filter(name="enterochromaffin-like cell")

cxg.Artifact.filter(
    suffix=".h5ad",
    description__contains="immune",
    size__gt=1e9,  # size > 1GB
    cell_types__in=[
        cell_types.b_cell,
        cell_types.t_cell,
    ],
).order_by("created_at").to_dataframe(
    include=["cell_types__name", "created_by__handle"]  # join with additional info
).head()

Attributes

Artifact: QuerySet[Artifact]

Query artifacts.

Collection: QuerySet[Collection]

Query collections.

Transform: QuerySet[Transform]

Query transforms.

Run: QuerySet[Run]

Query runs.

User: QuerySet[User]

Query users.

Storage: QuerySet[Storage]

Query storages.

Feature: QuerySet[Feature]

Query features.

ULabel: QuerySet[ULabel]

Query ulabels.

Record: QuerySet[Record]

Query records.

Schema: QuerySet[Schema]

Query schemas.

Project: QuerySet[Project]

Query projects.

Reference: QuerySet[Reference]

Query references.

Branch: QuerySet[Branch]

Query branches.

Space: QuerySet[Space]

Query spaces.

bionty: BiontyQueryDB

Namespace for Bionty registries (Gene, CellType, Disease, etc.).

wetlab: WetlabQueryDB

Namespace for wetlab registries (Experiment, Biosample, etc.).