Coverage for python/lsst/daf/butler/registry/bridge/ephemeral.py: 27%
42 statements
« prev ^ index » next coverage.py v7.2.7, created at 2023-07-21 09:55 +0000
« prev ^ index » next coverage.py v7.2.7, created at 2023-07-21 09:55 +0000
1# This file is part of daf_butler.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <http://www.gnu.org/licenses/>.
21from __future__ import annotations
23__all__ = ("EphemeralDatastoreRegistryBridge",)
25from collections.abc import Iterable, Iterator
26from contextlib import contextmanager
27from typing import TYPE_CHECKING
29from ...core import DatasetId
30from ..interfaces import DatasetIdRef, DatastoreRegistryBridge, FakeDatasetRef, OpaqueTableStorage
32if TYPE_CHECKING:
33 from ...core import StoredDatastoreItemInfo
34 from ...core.datastore import DatastoreTransaction
37class EphemeralDatastoreRegistryBridge(DatastoreRegistryBridge):
38 """An implementation of `DatastoreRegistryBridge` for ephemeral datastores
39 - those whose artifacts never outlive the current process.
41 Parameters
42 ----------
43 datastoreName : `str`
44 Name of the `Datastore` as it should appear in `Registry` tables
45 referencing it.
47 Notes
48 -----
49 The current implementation just uses a Python set to remember the dataset
50 IDs associated with the datastore. This will probably need to be converted
51 to use in-database temporary tables instead in the future to support
52 "in-datastore" constraints in `Registry.queryDatasets`.
53 """
55 def __init__(self, datastoreName: str):
56 super().__init__(datastoreName)
57 self._datasetIds: set[DatasetId] = set()
58 self._trashedIds: set[DatasetId] = set()
60 def insert(self, refs: Iterable[DatasetIdRef]) -> None:
61 # Docstring inherited from DatastoreRegistryBridge
62 self._datasetIds.update(ref.id for ref in refs)
64 def forget(self, refs: Iterable[DatasetIdRef]) -> None:
65 self._datasetIds.difference_update(ref.id for ref in refs)
67 def _rollbackMoveToTrash(self, refs: Iterable[DatasetIdRef]) -> None:
68 """Rollback a moveToTrash call."""
69 for ref in refs:
70 self._trashedIds.remove(ref.id)
72 def moveToTrash(self, refs: Iterable[DatasetIdRef], transaction: DatastoreTransaction | None) -> None:
73 # Docstring inherited from DatastoreRegistryBridge
74 if transaction is None:
75 raise RuntimeError("Must be called with a defined transaction.")
76 ref_list = list(refs)
77 with transaction.undoWith(f"Trash {len(ref_list)} datasets", self._rollbackMoveToTrash, ref_list):
78 self._trashedIds.update(ref.id for ref in ref_list)
80 def check(self, refs: Iterable[DatasetIdRef]) -> Iterable[DatasetIdRef]:
81 # Docstring inherited from DatastoreRegistryBridge
82 yield from (ref for ref in refs if ref in self)
84 def __contains__(self, ref: DatasetIdRef) -> bool:
85 return ref.id in self._datasetIds and ref.id not in self._trashedIds
87 @contextmanager
88 def emptyTrash(
89 self,
90 records_table: OpaqueTableStorage | None = None,
91 record_class: type[StoredDatastoreItemInfo] | None = None,
92 record_column: str | None = None,
93 ) -> Iterator[tuple[Iterable[tuple[DatasetIdRef, StoredDatastoreItemInfo | None]], set[str] | None]]:
94 # Docstring inherited from DatastoreRegistryBridge
95 matches: Iterable[tuple[FakeDatasetRef, StoredDatastoreItemInfo | None]] = ()
96 if isinstance(records_table, OpaqueTableStorage):
97 if record_class is None:
98 raise ValueError("Record class must be provided if records table is given.")
99 matches = (
100 (FakeDatasetRef(id), record_class.from_record(record))
101 for id in self._trashedIds
102 for record in records_table.fetch(dataset_id=id)
103 )
104 else:
105 matches = ((FakeDatasetRef(id), None) for id in self._trashedIds)
107 # Indicate to caller that we do not know about artifacts that
108 # should be retained.
109 yield ((matches, None))
111 if isinstance(records_table, OpaqueTableStorage):
112 # Remove the records entries
113 records_table.delete(["dataset_id"], *[{"dataset_id": id} for id in self._trashedIds])
115 # Empty the trash table
116 self._datasetIds.difference_update(self._trashedIds)
117 self._trashedIds = set()