Inheritance diagram for lsst.dax.apdb.apdbMetadata.ApdbMetadata:
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) |
Detailed Description
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.
Member Function Documentation
◆ delete()
| 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.
84 def delete(self, key: str) -> bool:
85 """Delete metadata record.
86
87 Parameters
88 ----------
89 key : `str`
90 Metadata key, arbitrary non-empty string.
91
92 Returns
93 -------
94 existed : `bool`
95 `True` is returned if attribute existed before it was deleted.
96 """
97 raise NotImplementedError()
98
◆ empty()
| 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.
113 def empty(self) -> bool:
114 """Check whether attributes set is empty.
115
116 Returns
117 -------
118 empty : `bool`
119 `True` if there are no any attributes defined. `True` is also
120 returned if metadata table is missing.
121 """
122 raise NotImplementedError()
◆ get()
| 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.
39 def get(self, key: str, default: str | None = None) -> str | None:
40 """Retrieve value of a given metadata record.
41
42 Parameters
43 ----------
44 key : `str`
45 Metadata key, arbitrary non-empty string.
46 default : `str`, optional
47 Default value returned when key does not exist, can be string
48 or `None`.
49
50 Returns
51 -------
52 value : `str` or `None`
53 Metadata value, if key does not exist then ``default`` is returned.
54 """
55 raise NotImplementedError()
56
◆ items()
| 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.
101 """Iterate over records and yield their keys and values.
102
103 Yields
104 ------
105 key : `str`
106 Metadata key.
107 value : `str`
108 Corresponding metadata value.
109 """
110 raise NotImplementedError()
111
◆ set()
| 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.
59 """Set value for a given metadata record.
60
61 Parameters
62 ----------
63 key : `str`
64 Metadata key, arbitrary non-empty string.
65 value : `str`
66 New metadata value, an arbitrary string. Due to deficiencies of
67 some database engines we are not allowing empty strings to be
68 stored in the database, and ``value`` cannot be an empty string.
69 force : `bool`, optional
70 Controls handling of existing metadata. With default `False`
71 value an exception is raised if ``key`` already exists, if `True`
72 is passed then value of the existing key will be updated.
73
74 Raises
75 ------
76 KeyError
77 Raised if key already exists but ``force`` option is false.
78 ValueError
79 Raised if key or value parameters are empty.
80 """
81 raise NotImplementedError()
82
The documentation for this class was generated from the following file:
- /j/snowflake/release/lsstsw/stack/lsst-scipipe-8.0.0/Linux64/dax_apdb/g295015adf3+81dd352a9d/python/lsst/dax/apdb/apdbMetadata.py
