LSST Applications 27.0.0,g0265f82a02+469cd937ee,g02d81e74bb+21ad69e7e1,g1470d8bcf6+cbe83ee85a,g2079a07aa2+e67c6346a6,g212a7c68fe+04a9158687,g2305ad1205+94392ce272,g295015adf3+81dd352a9d,g2bbee38e9b+469cd937ee,g337abbeb29+469cd937ee,g3939d97d7f+72a9f7b576,g487adcacf7+71499e7cba,g50ff169b8f+5929b3527e,g52b1c1532d+a6fc98d2e7,g591dd9f2cf+df404f777f,g5a732f18d5+be83d3ecdb,g64a986408d+21ad69e7e1,g858d7b2824+21ad69e7e1,g8a8a8dda67+a6fc98d2e7,g99cad8db69+f62e5b0af5,g9ddcbc5298+d4bad12328,ga1e77700b3+9c366c4306,ga8c6da7877+71e4819109,gb0e22166c9+25ba2f69a1,gb6a65358fc+469cd937ee,gbb8dafda3b+69d3c0e320,gc07e1c2157+a98bf949bb,gc120e1dc64+615ec43309,gc28159a63d+469cd937ee,gcf0d15dbbd+72a9f7b576,gdaeeff99f8+a38ce5ea23,ge6526c86ff+3a7c1ac5f1,ge79ae78c31+469cd937ee,gee10cc3b42+a6fc98d2e7,gf1cff7945b+21ad69e7e1,gfbcc870c63+9a11dc8c8f
LSST Data Management Base Package
Loading...
Searching...
No Matches
apdbMetadataSql.py
Go to the documentation of this file.
1# This file is part of dax_apdb.
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/>.
21
22from __future__ import annotations
23
24__all__ = ["ApdbMetadataSql"]
25
26from collections.abc import Generator
27
28import sqlalchemy
29
30from ..apdbMetadata import ApdbMetadata
31
32
34 """Implementation of `ApdbMetadata` for SQL backend.
35
36 Parameters
37 ----------
38 engine : `sqlalchemy.engine.Engine`
39 Database access engine.
40 table : `sqlalchemy.schema.Table` or `None`
41 Database table holding metadata. If table does not exists then `None`
42 should be specified.
43 """
44
45 def __init__(self, engine: sqlalchemy.engine.Engine, table: sqlalchemy.schema.Table | None):
46 self._engine = engine
47 self._table = table
48
49 def get(self, key: str, default: str | None = None) -> str | None:
50 # Docstring is inherited.
51 if self._table is None:
52 return default
53 sql = sqlalchemy.sql.select(self._table.columns.value).where(self._table.columns.name == key)
54 with self._engine.begin() as conn:
55 result = conn.execute(sql)
56 value = result.scalar()
57 if value is not None:
58 return value
59 return default
60
61 def set(self, key: str, value: str, *, force: bool = False) -> None:
62 # Docstring is inherited.
63 if self._table is None:
64 raise RuntimeError("Metadata table does not exist")
65 if not key or not value:
66 raise ValueError("name and value cannot be empty")
67 try:
68 insert = sqlalchemy.sql.insert(self._table).values(name=key, value=value)
69 with self._engine.begin() as conn:
70 conn.execute(insert)
71 except sqlalchemy.exc.IntegrityError as exc:
72 # Try to update if it exists.
73 if not force:
74 raise KeyError(f"Metadata key {key!r} already exists") from exc
75 update = (
76 sqlalchemy.sql.update(self._table).where(self._table.columns.name == key).values(value=value)
77 )
78 with self._engine.begin() as conn:
79 result = conn.execute(update)
80 if result.rowcount != 1:
81 raise RuntimeError(f"Metadata update failed unexpectedly, count={result.rowcount}")
82
83 def delete(self, key: str) -> bool:
84 # Docstring is inherited.
85 if self._table is None:
86 # Missing table means nothing to delete.
87 return False
88 stmt = sqlalchemy.sql.delete(self._table).where(self._table.columns.name == key)
89 with self._engine.begin() as conn:
90 result = conn.execute(stmt)
91 return result.rowcount > 0
92
93 def items(self) -> Generator[tuple[str, str], None, None]:
94 # Docstring is inherited.
95 if self._table is None:
96 # Missing table means nothing to return.
97 return
98 stmt = sqlalchemy.sql.select(self._table.columns.name, self._table.columns.value)
99 with self._engine.begin() as conn:
100 result = conn.execute(stmt)
101 for row in result:
102 yield row._tuple()
103
104 def empty(self) -> bool:
105 # Docstring is inherited.
106 if self._table is None:
107 # Missing table means empty.
108 return True
109 stmt = sqlalchemy.sql.select(sqlalchemy.sql.func.count()).select_from(self._table)
110 with self._engine.begin() as conn:
111 result = conn.execute(stmt)
112 count = result.scalar()
113 return count == 0
114
115 def table_exists(self) -> bool:
116 """Return `True` if metadata table exists."""
117 return self._table is not None
std::vector< SchemaItem< Flag > > * items
__init__(self, sqlalchemy.engine.Engine engine, sqlalchemy.schema.Table|None table)
str|None get(self, str key, str|None default=None)
daf::base::PropertySet * set
Definition fits.cc:931