StoredFileInfo

class lsst.daf.butler.StoredFileInfo(formatter: FormatterParameter, path: str, storageClass: StorageClass, component: str | None, checksum: str | None, file_size: int, dataset_id: DatasetId)

Bases: StoredDatastoreItemInfo

Datastore-private metadata associated with a Datastore file.

Attributes Summary

checksum	Checksum of the serialized dataset.
component	Component associated with this file.
dataset_id	DatasetId associated with this record.
file_size	Size of the serialized dataset in bytes.
formatter	Fully-qualified name of Formatter.
path	Path to dataset within Datastore.
storageClass	StorageClass associated with Dataset.
storageClassFactory

Methods Summary

file_location(factory)	Return the location of artifact.
from_record(record)	Create instance from database record.
rebase(ref)	Return a copy of the record suitable for a specified reference.
to_record()	Convert the supplied ref to a database record.

Attributes Documentation

checksum: str | None

Checksum of the serialized dataset.

component: str | None

Component associated with this file. Can be None if the file does not refer to a component of a composite.

dataset_id: DatasetId

DatasetId associated with this record.

file_size: int

Size of the serialized dataset in bytes.

formatter: str

Fully-qualified name of Formatter. If a Formatter class or instance is given the name will be extracted.

path: str

Path to dataset within Datastore.

storageClass: StorageClass

StorageClass associated with Dataset.

storageClassFactory = <lsst.daf.butler.core.storageClass.StorageClassFactory object>

Methods Documentation

file_location(factory: LocationFactory) → Location

Return the location of artifact.

Parameters:

factoryLocationFactory

Factory relevant to the datastore represented by this item.

Returns:

locationLocation

The location of the item within this datastore.

classmethod from_record(record: Mapping[str, Any]) → StoredFileInfo

Create instance from database record.

Parameters:

recorddict

The record associated with this item.

Returns:

infoStoredFileInfo

The newly-constructed item corresponding to the record.

rebase(ref: DatasetRef) → StoredFileInfo

Return a copy of the record suitable for a specified reference.

Parameters:

refDatasetRef

DatasetRef which provides component name and dataset ID for the new returned record.

Returns:

recordStoredFileInfo

New record instance.

to_record() → Dict[str, Any]

Convert the supplied ref to a database record.