Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+cc8870d3f5,g07dc498a13+5aa0b8792f,g0fba68d861+80045be308,g1409bbee79+5aa0b8792f,g1a7e361dbc+5aa0b8792f,g1fd858c14a+f64bc332a9,g208c678f98+1ae86710ed,g35bb328faa+fcb1d3bbc8,g4d2262a081+47ad8a29a8,g4d39ba7253+9633a327c1,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g60b5630c4e+9633a327c1,g668ecb457e+25d63fd678,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+8b64ca622a,g89139ef638+5aa0b8792f,g89e1512fd8+04325574d3,g8d6b6b353c+9633a327c1,g9125e01d80+fcb1d3bbc8,g989de1cb63+5aa0b8792f,g9f33ca652e+b196626af7,ga9baa6287d+9633a327c1,gaaedd4e678+5aa0b8792f,gabe3b4be73+1e0a283bba,gb1101e3267+71e32094df,gb58c049af0+f03b321e39,gb90eeb9370+2807b1ad02,gcf25f946ba+8b64ca622a,gd315a588df+a39986a76f,gd6cbbdb0b4+c8606af20c,gd9a9a58781+fcb1d3bbc8,gde0f65d7ad+4e42d81ab7,ge278dab8ac+932305ba37,ge82c20c137+76d20ab76d,gfe73954cf8+a1301e4c20,w.2025.11
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
lsst.dax.apdb.scripts.metadata Namespace Reference

Functions

None metadata_delete (str config, str key)
 
None metadata_get (str config, str key)
 
None metadata_set (str config, str key, str value, bool force)
 
None metadata_show (str config, bool use_json)
 

Function Documentation

◆ metadata_delete()

None lsst.dax.apdb.scripts.metadata.metadata_delete ( str config,
str key )
Delete metadata key.

Parameters
----------
config : `str`
    Path or URI of APDB configuration file.
key : `str`
    Metadata key.

Definition at line 32 of file metadata.py.

32def metadata_delete(config: str, key: str) -> None:
33 """Delete metadata key.
34
35 Parameters
36 ----------
37 config : `str`
38 Path or URI of APDB configuration file.
39 key : `str`
40 Metadata key.
41 """
42 apdb = Apdb.from_uri(config)
43 apdb.metadata.delete(key)
44
45

◆ metadata_get()

None lsst.dax.apdb.scripts.metadata.metadata_get ( str config,
str key )
Print value of the metadata item.

Parameters
----------
config : `str`
    Path or URI of APDB configuration file.
key : `str`
    Metadata key.

Definition at line 46 of file metadata.py.

46def metadata_get(config: str, key: str) -> None:
47 """Print value of the metadata item.
48
49 Parameters
50 ----------
51 config : `str`
52 Path or URI of APDB configuration file.
53 key : `str`
54 Metadata key.
55 """
56 apdb = Apdb.from_uri(config)
57 value = apdb.metadata.get(key)
58 if value is None:
59 raise KeyError(f"Metadata key {key!r} does not exist.")
60 else:
61 print(value)
62
63

◆ metadata_set()

None lsst.dax.apdb.scripts.metadata.metadata_set ( str config,
str key,
str value,
bool force )
Add or update metadata item.

Parameters
----------
config : `str`
    Path or URI of APDB configuration file.
key : `str`
    Metadata key.
value : `str`
    Metadata value.
force : `bool`
    Set to True to allow updates for existing keys.

Definition at line 64 of file metadata.py.

64def metadata_set(config: str, key: str, value: str, force: bool) -> None:
65 """Add or update metadata item.
66
67 Parameters
68 ----------
69 config : `str`
70 Path or URI of APDB configuration file.
71 key : `str`
72 Metadata key.
73 value : `str`
74 Metadata value.
75 force : `bool`
76 Set to True to allow updates for existing keys.
77 """
78 apdb = Apdb.from_uri(config)
79 apdb.metadata.set(key, value, force=force)
80
81

◆ metadata_show()

None lsst.dax.apdb.scripts.metadata.metadata_show ( str config,
bool use_json )
Show contents of APDB metadata table.

Parameters
----------
config : `str`
    Path or URI of APDB configuration file.
use_json : `bool`
    If True dump in JSON format.

Definition at line 82 of file metadata.py.

82def metadata_show(config: str, use_json: bool) -> None:
83 """Show contents of APDB metadata table.
84
85 Parameters
86 ----------
87 config : `str`
88 Path or URI of APDB configuration file.
89 use_json : `bool`
90 If True dump in JSON format.
91 """
92 apdb = Apdb.from_uri(config)
93 if use_json:
94 data = {key: value for key, value in apdb.metadata.items()}
95 json.dump(data, sys.stdout, indent=2)
96 print()
97 else:
98 for key, value in apdb.metadata.items():
99 print(f"{key}: {value}")