lamindb.models.DBRecord

class lamindb.models.DBRecord(*args, **kwargs)

Bases: BaseDBRecord

Metadata record.

Every DBRecord is a data model that comes with a registry in form of a SQL table in your database.

Sub-classing DBRecord creates a new registry while instantiating a DBRecord creates a new record.

Example:

from lamindb import DBRecord, fields

# sub-classing `DBRecord` creates a new registry
class Experiment(DBRecord):
    name: str = fields.CharField()

# instantiating `Experiment` creates a record `experiment`
experiment = Experiment(name="my experiment")

# you can save the record to the database
experiment.save()

# `Experiment` refers to the registry, which you can query
df = Experiment.filter(name__startswith="my ").df()

DBRecord’s metaclass is Registry.

DBRecord inherits from Django’s Model class. Why does LaminDB call it DBRecord and not Model? The term DBRecord can’t lead to confusion with statistical, machine learning or biological models.

Attributes

Meta = <class 'lamindb.models.dbrecord.DBRecord.Meta'>

property pk

space: Space

The space in which the record lives.

space_id

Methods

async adelete(using=None, keep_parents=False)

async arefresh_from_db(using=None, fields=None, from_queryset=None)

async asave(*args, force_insert=False, force_update=False, using=None, update_fields=None)

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

date_error_message(lookup_type, field_name, unique_for)

delete()

Delete.

Return type:

None

get_constraints()

get_deferred_fields()

Return a set containing names of deferred fields for this instance.

prepare_database_save(field)

refresh_from_db(using=None, fields=None, from_queryset=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

save(*args, **kwargs)

Save.

Always saves to the default database.

Return type:

DBRecord

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

unique_error_message(model_class, unique_check)

validate_constraints(exclude=None)

validate_unique(exclude=None)

Check unique constraints on the model and raise ValidationError if any failed.