Coverage for python/lsst/daf/butler/registry/collections/synthIntKey.py : 97%

Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
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__ = ["SynthIntKeyCollectionManager"]
25from typing import (
26 Any,
27 Dict,
28 Iterable,
29 Optional,
30 TYPE_CHECKING,
31)
33import sqlalchemy
35from ._base import (
36 CollectionTablesTuple,
37 DefaultCollectionManager,
38 makeRunTableSpec,
39 makeCollectionChainTableSpec,
40)
41from ...core import ddl
42from ..interfaces import CollectionRecord, VersionTuple
44if TYPE_CHECKING: 44 ↛ 45line 44 didn't jump to line 45, because the condition on line 44 was never true
45 from ..interfaces import Database, StaticTablesContext
48_TABLES_SPEC = CollectionTablesTuple(
49 collection=ddl.TableSpec(
50 fields=[
51 ddl.FieldSpec("collection_id", dtype=sqlalchemy.BigInteger, primaryKey=True, autoincrement=True),
52 ddl.FieldSpec("name", dtype=sqlalchemy.String, length=64, nullable=False),
53 ddl.FieldSpec("type", dtype=sqlalchemy.SmallInteger, nullable=False),
54 ],
55 unique=[("name",)],
56 ),
57 run=makeRunTableSpec("collection_id", sqlalchemy.BigInteger),
58 collection_chain=makeCollectionChainTableSpec("collection_id", sqlalchemy.BigInteger),
59)
61# This has to be updated on every schema change
62_VERSION = VersionTuple(0, 1, 0)
65class SynthIntKeyCollectionManager(DefaultCollectionManager):
66 """A `CollectionManager` implementation that uses synthetic primary key
67 (auto-incremented integer) for collections table.
69 Most of the logic, including caching policy, is implemented in the base
70 class, this class only adds customizations specific to this particular
71 table schema.
73 Parameters
74 ----------
75 db : `Database`
76 Interface to the underlying database engine and namespace.
77 tables : `NamedTuple`
78 Named tuple of SQLAlchemy table objects.
79 collectionIdName : `str`
80 Name of the column in collections table that identifies it (PK).
81 """
82 def __init__(self, db: Database, tables: CollectionTablesTuple, collectionIdName: str):
83 super().__init__(db=db, tables=tables, collectionIdName=collectionIdName)
84 self._nameCache: Dict[str, CollectionRecord] = {} # indexed by collection name
86 @classmethod
87 def initialize(cls, db: Database, context: StaticTablesContext) -> SynthIntKeyCollectionManager:
88 # Docstring inherited from CollectionManager.
89 return cls(db, tables=context.addTableTuple(_TABLES_SPEC), # type: ignore
90 collectionIdName="collection_id")
92 @classmethod
93 def getCollectionForeignKeyName(cls, prefix: str = "collection") -> str:
94 # Docstring inherited from CollectionManager.
95 return f"{prefix}_id"
97 @classmethod
98 def getRunForeignKeyName(cls, prefix: str = "run") -> str:
99 # Docstring inherited from CollectionManager.
100 return f"{prefix}_id"
102 @classmethod
103 def addCollectionForeignKey(cls, tableSpec: ddl.TableSpec, *, prefix: str = "collection",
104 onDelete: Optional[str] = None, **kwds: Any) -> ddl.FieldSpec:
105 # Docstring inherited from CollectionManager.
106 original = _TABLES_SPEC.collection.fields["collection_id"]
107 copy = ddl.FieldSpec(cls.getCollectionForeignKeyName(prefix), dtype=original.dtype, **kwds)
108 tableSpec.fields.add(copy)
109 tableSpec.foreignKeys.append(ddl.ForeignKeySpec("collection", source=(copy.name,),
110 target=(original.name,), onDelete=onDelete))
111 return copy
113 @classmethod
114 def addRunForeignKey(cls, tableSpec: ddl.TableSpec, *, prefix: str = "run",
115 onDelete: Optional[str] = None, **kwds: Any) -> ddl.FieldSpec:
116 # Docstring inherited from CollectionManager.
117 original = _TABLES_SPEC.run.fields["collection_id"]
118 copy = ddl.FieldSpec(cls.getRunForeignKeyName(prefix), dtype=original.dtype, **kwds)
119 tableSpec.fields.add(copy)
120 tableSpec.foreignKeys.append(ddl.ForeignKeySpec("run", source=(copy.name,),
121 target=(original.name,), onDelete=onDelete))
122 return copy
124 def _setRecordCache(self, records: Iterable[CollectionRecord]) -> None:
125 """Set internal record cache to contain given records,
126 old cached records will be removed.
127 """
128 self._records = {}
129 self._nameCache = {}
130 for record in records:
131 self._records[record.key] = record
132 self._nameCache[record.name] = record
134 def _addCachedRecord(self, record: CollectionRecord) -> None:
135 """Add single record to cache.
136 """
137 self._records[record.key] = record
138 self._nameCache[record.name] = record
140 def _removeCachedRecord(self, record: CollectionRecord) -> None:
141 """Remove single record from cache.
142 """
143 del self._records[record.key]
144 del self._nameCache[record.name]
146 def _getByName(self, name: str) -> Optional[CollectionRecord]:
147 # Docstring inherited from DefaultCollectionManager.
148 return self._nameCache.get(name)
150 @classmethod
151 def currentVersion(cls) -> Optional[VersionTuple]:
152 # Docstring inherited from VersionedExtension.
153 return _VERSION
155 def schemaDigest(self) -> Optional[str]:
156 # Docstring inherited from VersionedExtension.
157 return self._defaultSchemaDigest(self._tables)