5.6.10. rundb - Helper classes for retrieving information from the RunDB

This modules contains classes useful to deal with the RunDB:

• RunDB, a simple API class to just get run information from the RunDB

class rundb.RunDB(apikey=None, username=None)

Simple API class to just get run information from the RunDB.

Parameters

• apikey (str) – RunDB API key (see this question or this Confluence page how to get one)

• username (str) – DESY username

URL = 'https://rundb.belle2.org'

URL of where the RunDB is hosted

get_details(run_summary)

Return details for a run summary object returned from get_run_info if expand was not set to True

Parameters

run_summary – a run summary object returned from get_run_info

get_run_info(**search_params)

Return the run information from the run registry.

All arguments are forwarded to the run registry /run/ method documented at the following link. Please check there for up to date documentation, at the time of this writing the supported arguments are:

• min_experiment (int)

• min_run (int)

• max_experiment (int)

• max_run (int)

• min_date (iso8601 date string, e.g. 2020-05-06)

• max_date (iso8601 date string, e.g. 2020-05-06)

• all_detectors_running (bool)

• expand (bool): If true return full run objects, not just a summary links to the run objects

If expand=False you can request the full objects for each run by calling get_details with the returned run summary object as argument. expand=False is much faster if no further details are needed but getting the details in a separate step for many many runs will be slow so depending on how many runs are selected one or the other may be faster.