DatastoreRecordData¶
- class lsst.daf.butler.DatastoreRecordData(records: dict[uuid.UUID, dict[str, list[lsst.daf.butler.core.storedFileInfo.StoredDatastoreItemInfo]]] = <factory>)¶
Bases:
object
A struct that represents a tabular data export from a single datastore.
Methods Summary
from_simple
(simple[, universe, registry])Make an instance of this class from serialized data.
subset
(dataset_ids)Extract a subset of the records that match given dataset IDs.
to_simple
([minimal])Make representation of the object for serialization.
update
(other)Update contents of this instance with data from another instance.
Methods Documentation
- classmethod from_simple(simple: SerializedDatastoreRecordData, universe: DimensionUniverse | None = None, registry: Registry | None = None) DatastoreRecordData ¶
Make an instance of this class from serialized data.
Implements
SupportsSimple
protocol.- Parameters:
- data
dict
Serialized representation returned from
to_simple
method.- universe
DimensionUniverse
, optional Dimension universe, not used by this method.
- registry
Registry
, optional Registry instance, not used by this method.
- data
- Returns:
- item_info
StoredDatastoreItemInfo
De-serialized instance of
StoredDatastoreItemInfo
.
- item_info
- subset(dataset_ids: set[uuid.UUID]) DatastoreRecordData | None ¶
Extract a subset of the records that match given dataset IDs.
- Parameters:
- dataset_ids
set
[DatasetId
] Dataset IDs to match.
- dataset_ids
- Returns:
- record_data
DatastoreRecordData
orNone
None
is returned if there are no matching refs.
- record_data
Notes
Records in the returned instance are shared with this instance, clients should not update or extend records in the returned instance.
- to_simple(minimal: bool = False) SerializedDatastoreRecordData ¶
Make representation of the object for serialization.
Implements
SupportsSimple
protocol.
- update(other: DatastoreRecordData) None ¶
Update contents of this instance with data from another instance.
- Parameters:
- other
DatastoreRecordData
Records to merge into this instance.
- other
Notes
If a
(dataset_id, table_name)
combination has any records inself
, it is assumed that all records for that combination are already present. This allows duplicates of the same dataset to be handled gracefully.