databroker.Header.documents

Header.documents(stream_name=<class 'databroker.utils.ALL'>, fields=None, fill=False)

Load all documents from the run.

This is a generator the yields (name, doc).

Parameters

stream_namestring or ALL, optional

Filter results by stream name (e.g., ‘primary’, ‘baseline’). The default, ALL, combines results from all streams.

fillbool, optional

Whether externally-stored data should be filled in. False by default.

Yields

name, doc(string, dict)

Examples

Loop through the documents from a run.

>>> h = db[-1]
>>> for name, doc in h.documents():
...     # do something