Reference#

LaminDB: Manage R&D data & analyses.

Import the package:

import lamindb as ln

The central class of the API is File, a wrapper for files, on-disk (zarr, etc.) and in-memory data objects (DataFrame, AnnData, etc.).

File([data, features, source, format, id, ...])

Files: serialized data objects.

Folder([folder, id, name, x])

Data folders, collections of data objects.

Track runs of data transformations:

Run(*[, id, name, load_latest, external_id, ...])

Runs of data transforms.

Transform(*[, id, v, type, title, ...])

Data transformations.

Tracking data by features:

Features([data, reference, id, type, files])

Feature sets.

Query & manipulate data:

select(*entity, **fields)

Select data.

add()

Insert or update data records.

delete()

Delete data records & data objects.

Manipulate data with open session:

Session()

Database session.

Utility functions:

track(*[, id, version, name, transform, ...])

Track Transform & Run records for a notebook or pipeline.

view([n, schema])

View data.

Basic entities:

User(*, id, email, handle[, name, updated_at])

User accounts.

Project(*[, id, created_by, updated_at])

Projects.

StorageRoot

alias of Storage

Schema - entities and their relations:

schema

Schema tools & overview.

Setup:

setup

LaminDB setup.

Developer API:

context()

Global run context.

settings()

Settings.

dev

Developer API.