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.

def metadata_delete(config: str, key: str) -> None:
    """Delete metadata key.
 
    Parameters
    ----------
    config : `str`
        Path or URI of APDB configuration file.
    key : `str`
        Metadata key.
    """
    apdb = Apdb.from_uri(config)
    apdb.metadata.delete(key)
 
 

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.

def metadata_get(config: str, key: str) -> None:
    """Print value of the metadata item.
 
    Parameters
    ----------
    config : `str`
        Path or URI of APDB configuration file.
    key : `str`
        Metadata key.
    """
    apdb = Apdb.from_uri(config)
    value = apdb.metadata.get(key)
    if value is None:
        raise KeyError(f"Metadata key {key!r} does not exist.")
    else:
        print(value)
 
 

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.

def metadata_set(config: str, key: str, value: str, force: bool) -> None:
    """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.
    """
    apdb = Apdb.from_uri(config)
    apdb.metadata.set(key, value, force=force)
 
 

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.

def metadata_show(config: str, use_json: bool) -> None:
    """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.
    """
    apdb = Apdb.from_uri(config)
    if use_json:
        data = dict(apdb.metadata.items())
        json.dump(data, sys.stdout, indent=2)
        print()
    else:
        for key, value in apdb.metadata.items():
            print(f"{key}: {value}")