lsst.dax.apdb.scripts.list_index Namespace Reference

Functions
None	list_index (str|None index_path)

Function Documentation

list_index()

None lsst.dax.apdb.scripts.list_index.list_index

(

str | None

index_path

)

List contents of APDB index file.

Parameters
----------
index_path : `str`, optional
    Location of index file, if missing then $DAX_APDB_INDEX_URI is used.

Definition at line 29 of file list_index.py.

def list_index(index_path: str | None) -> None:
    """List contents of APDB index file.
 
    Parameters
    ----------
    index_path : `str`, optional
        Location of index file, if missing then $DAX_APDB_INDEX_URI is used.
    """
    index = ApdbIndex(index_path)
    entries = index.get_entries()
    for label, uri in sorted(entries.items()):
        print(f"{label}: {uri}")