LSST Applications g180d380827+770a9040cc,g2079a07aa2+86d27d4dc4,g2305ad1205+09cfdadad9,g2bbee38e9b+c6a8a0fb72,g337abbeb29+c6a8a0fb72,g33d1c0ed96+c6a8a0fb72,g3a166c0a6a+c6a8a0fb72,g3ddfee87b4+1ea5e09c42,g48712c4677+7e2ea9cd42,g487adcacf7+301d09421d,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+96fcb956a6,g64a986408d+23540ee355,g858d7b2824+23540ee355,g864b0138d7+aa38e45daa,g95921f966b+d83dc58ecd,g991b906543+23540ee355,g99cad8db69+7f13b58a93,g9c22b2923f+e2510deafe,g9ddcbc5298+9a081db1e4,ga1e77700b3+03d07e1c1f,gb0e22166c9+60f28cb32d,gb23b769143+23540ee355,gba4ed39666+c2a2e4ac27,gbb8dafda3b+49e7449578,gbd998247f1+585e252eca,gc120e1dc64+1bbfa184e1,gc28159a63d+c6a8a0fb72,gc3e9b769f7+385ea95214,gcf0d15dbbd+1ea5e09c42,gdaeeff99f8+f9a426f77a,ge6526c86ff+1bccc98490,ge79ae78c31+c6a8a0fb72,gee10cc3b42+585e252eca,w.2024.18
LSST Data Management Base Package
|
Public Member Functions | |
str|None | get (self, str key, str|None default=None) |
None | set (self, str key, str value, *bool force=False) |
bool | delete (self, str key) |
Generator[tuple[str, str], None, None] | items (self) |
bool | empty (self) |
Interface for accessing APDB metadata. Metadata is a collection of key/value items usually stored in a special table in the database. This abstract interface provides methods for accessing and modifying it.
Definition at line 30 of file apdbMetadata.py.
bool lsst.dax.apdb.apdbMetadata.ApdbMetadata.delete | ( | self, | |
str | key ) |
Delete metadata record. Parameters ---------- key : `str` Metadata key, arbitrary non-empty string. Returns ------- existed : `bool` `True` is returned if attribute existed before it was deleted.
Reimplemented in lsst.dax.apdb.cassandra.apdbMetadataCassandra.ApdbMetadataCassandra, and lsst.dax.apdb.sql.apdbMetadataSql.ApdbMetadataSql.
Definition at line 84 of file apdbMetadata.py.
bool lsst.dax.apdb.apdbMetadata.ApdbMetadata.empty | ( | self | ) |
Check whether attributes set is empty. Returns ------- empty : `bool` `True` if there are no any attributes defined. `True` is also returned if metadata table is missing.
Reimplemented in lsst.dax.apdb.cassandra.apdbMetadataCassandra.ApdbMetadataCassandra, and lsst.dax.apdb.sql.apdbMetadataSql.ApdbMetadataSql.
Definition at line 113 of file apdbMetadata.py.
str | None lsst.dax.apdb.apdbMetadata.ApdbMetadata.get | ( | self, | |
str | key, | ||
str | None | default = None ) |
Retrieve value of a given metadata record. Parameters ---------- key : `str` Metadata key, arbitrary non-empty string. default : `str`, optional Default value returned when key does not exist, can be string or `None`. Returns ------- value : `str` or `None` Metadata value, if key does not exist then ``default`` is returned.
Reimplemented in lsst.dax.apdb.cassandra.apdbMetadataCassandra.ApdbMetadataCassandra, and lsst.dax.apdb.sql.apdbMetadataSql.ApdbMetadataSql.
Definition at line 39 of file apdbMetadata.py.
Generator[tuple[str, str], None, None] lsst.dax.apdb.apdbMetadata.ApdbMetadata.items | ( | self | ) |
Iterate over records and yield their keys and values. Yields ------ key : `str` Metadata key. value : `str` Corresponding metadata value.
Reimplemented in lsst.dax.apdb.cassandra.apdbMetadataCassandra.ApdbMetadataCassandra, and lsst.dax.apdb.sql.apdbMetadataSql.ApdbMetadataSql.
Definition at line 100 of file apdbMetadata.py.
None lsst.dax.apdb.apdbMetadata.ApdbMetadata.set | ( | self, | |
str | key, | ||
str | value, | ||
*bool | force = False ) |
Set value for a given metadata record. Parameters ---------- key : `str` Metadata key, arbitrary non-empty string. value : `str` New metadata value, an arbitrary string. Due to deficiencies of some database engines we are not allowing empty strings to be stored in the database, and ``value`` cannot be an empty string. force : `bool`, optional Controls handling of existing metadata. With default `False` value an exception is raised if ``key`` already exists, if `True` is passed then value of the existing key will be updated. Raises ------ KeyError Raised if key already exists but ``force`` option is false. ValueError Raised if key or value parameters are empty.
Reimplemented in lsst.dax.apdb.cassandra.apdbMetadataCassandra.ApdbMetadataCassandra, and lsst.dax.apdb.sql.apdbMetadataSql.ApdbMetadataSql.
Definition at line 58 of file apdbMetadata.py.