LSST Applications g0f08755f38+9c285cab97,g1635faa6d4+13f3999e92,g1653933729+a8ce1bb630,g1a0ca8cf93+bf6eb00ceb,g28da252d5a+0829b12dee,g29321ee8c0+5700dc9eac,g2bbee38e9b+9634bc57db,g2bc492864f+9634bc57db,g2cdde0e794+c2c89b37c4,g3156d2b45e+41e33cbcdc,g347aa1857d+9634bc57db,g35bb328faa+a8ce1bb630,g3a166c0a6a+9634bc57db,g3e281a1b8c+9f2c4e2fc3,g414038480c+077ccc18e7,g41af890bb2+fde0dd39b6,g5fbc88fb19+17cd334064,g781aacb6e4+a8ce1bb630,g80478fca09+55a9465950,g82479be7b0+d730eedb7d,g858d7b2824+9c285cab97,g9125e01d80+a8ce1bb630,g9726552aa6+10f999ec6a,ga5288a1d22+2a84bb7594,gacf8899fa4+c69c5206e8,gae0086650b+a8ce1bb630,gb58c049af0+d64f4d3760,gc28159a63d+9634bc57db,gcf0d15dbbd+4b7d09cae4,gda3e153d99+9c285cab97,gda6a2b7d83+4b7d09cae4,gdaeeff99f8+1711a396fd,ge2409df99d+5e831397f4,ge79ae78c31+9634bc57db,gf0baf85859+147a0692ba,gf3967379c6+41c94011de,gf3fb38a9a8+8f07a9901b,gfb92a5be7c+9c285cab97,w.2024.46
LSST Data Management Base Package
Loading...
Searching...
No Matches
Functions
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}")