lamindb.add

lamindb.add(record, **fields)

Insert or update data records.

Inserts a new record if the corresponding row doesn’t exist. Updates the corresponding row with the record if it exists.

To update a row, query it with .select and modify it before passing it to add.

Parameters:

record – One or multiple records as instances of SQLModel.

Return type:

Union[SQLModel, List[SQLModel]]

Returns:

The record as returned from the database with a created_at timestamp.

Examples

Add a record (errors if already exists):

>>> ln.add(ln.Transform(name="My pipeline"))
Transform(id="0Cb86EZj", name="My pipeline", ...)

Update an existing record:

>>> transform = ln.select(ln.Transform, id="0Cb86EZj").one()
>>> transform.name = "New name"
>>> ln.add(transform)
Transform(id="0Cb86EZj", name="New name", ...)

Add a record with passed fields if not yet exists:

>>> # add a record if the metadata combination is not already exist in the DB
>>> # if exists, returns the existing record from the DB
>>> ln.add(ln.Transform, name="My transform", v="1")
Transform(id="0Cb86EZj", name="My pipeline", ...)
>>> # is equivalent to the following:
>>> transform = ln.select(ln.Transform, name="My transform", v="1").one_or_none()
>>> if transform is None:
>>>     ln.add(transform)