RunRecord

class lsst.daf.butler.registry.interfaces.RunRecord(key: Any, name: str, type: lsst.daf.butler.registry._collectionType.CollectionType)

Bases: lsst.daf.butler.registry.interfaces.CollectionRecord

A subclass of CollectionRecord that adds execution information and an interface for updating it.

Attributes Summary

host Return the name of the host or system on which this run was produced (str or None).
timespan Begin and end timestamps for the period over which the run was produced.

Methods Summary

update(host, timespan) Update the database record for this run with new execution information.

Attributes Documentation

host

Return the name of the host or system on which this run was produced (str or None).

timespan

Begin and end timestamps for the period over which the run was produced. None/NULL values are interpreted as infinite bounds.

Methods Documentation

update(host: Optional[str] = None, timespan: Optional[lsst.daf.butler.core.timespan.Timespan] = None) → None

Update the database record for this run with new execution information.

Values not provided will set to NULL in the database, not ignored.

Parameters:
host : str, optional

Name of the host or system on which this run was produced. Detailed form to be set by higher-level convention; from the Registry perspective, this is an entirely opaque value.

timespan : Timespan, optional

Begin and end timestamps for the period over which the run was produced. None/NULL values are interpreted as infinite bounds.