DatastoreRegistryBridge¶

class lsst.daf.butler.registry.interfaces.DatastoreRegistryBridge(datastoreName: str)¶

Bases: abc.ABC

An abstract base class that defines the interface that a Datastore uses to communicate with a Registry.

Parameters

datastoreNamestr: Name of the Datastore as it should appear in Registry tables referencing it.

Methods Summary

`check`(refs)	Check which refs are listed for this datastore.
`emptyTrash`()	Retrieve all the dataset ref IDs that are in the trash associated for this datastore, and then remove them if the context exists without an exception being raised.
`forget`(refs)	Remove dataset location information without any attempt to put it in the trash while waiting for external deletes.
`insert`(refs)	Record that a datastore holds the given datasets.
`moveToTrash`(refs)	Move dataset location information to trash.

Methods Documentation

abstract check(refs: Iterable[Union[lsst.daf.butler.DatasetRef, lsst.daf.butler.registry.interfaces.FakeDatasetRef]]) → Iterable[Union[lsst.daf.butler.DatasetRef, lsst.daf.butler.registry.interfaces.FakeDatasetRef]]¶

Check which refs are listed for this datastore.

Parameters

refsIterable of DatasetIdRef: References to the datasets.

Returns

presentIterable [ DatasetIdRef ]: Datasets from refs that are recorded as being in this datastore.

Raises

AmbiguousDatasetError: Raised if any(ref.id is None for ref in refs).

abstract emptyTrash() → AbstractContextManager[Iterable[Union[lsst.daf.butler.DatasetRef, lsst.daf.butler.registry.interfaces.FakeDatasetRef]]]¶

Retrieve all the dataset ref IDs that are in the trash associated for this datastore, and then remove them if the context exists without an exception being raised.

Returns

idsset of DatasetIdRef: The IDs of datasets that can be safely removed from this datastore. Can be empty.

Notes

The object yielded by the context manager may be a single-pass iterator. If multiple passes are required, it should be converted to a list or other container.

Datastores should never raise (except perhaps in testing) when an artifact cannot be removed only because it is already gone - this condition is an unavoidable outcome of concurrent delete operations, and must not be considered and error for those to be safe.

Examples

Typical usage by a Datastore is something like:

with self.bridge.emptyTrash() as iter:
    for ref in iter:
        # Remove artifacts associated with ref.id,
        # raise an exception if something goes wrong.

abstract forget(refs: Iterable[Union[lsst.daf.butler.DatasetRef, lsst.daf.butler.registry.interfaces.FakeDatasetRef]]) → None ¶

Remove dataset location information without any attempt to put it in the trash while waiting for external deletes.

This should be used only to implement Datastore.forget, or in cases where deleting the actual datastore artifacts cannot fail.

Parameters

refsIterable of DatasetIdRef: References to the datasets.

Raises

AmbiguousDatasetError: Raised if any(ref.id is None for ref in refs).

abstract insert(refs: Iterable[Union[lsst.daf.butler.DatasetRef, lsst.daf.butler.registry.interfaces.FakeDatasetRef]]) → None ¶

Record that a datastore holds the given datasets.

Parameters

refsIterable of DatasetIdRef: References to the datasets.

Raises

AmbiguousDatasetError: Raised if any(ref.id is None for ref in refs).

abstract moveToTrash(refs: Iterable[Union[lsst.daf.butler.DatasetRef, lsst.daf.butler.registry.interfaces.FakeDatasetRef]]) → None ¶

Move dataset location information to trash.

Parameters

refsIterable of DatasetIdRef: References to the datasets.

Raises

AmbiguousDatasetError: Raised if any(ref.id is None for ref in refs).

Navigation

DatastoreRegistryBridge¶