databroker.Broker.restream

Broker.restream(headers, fields=None, fill=False)[source]

Get all Documents from given run(s).

This output can be used as a drop-in replacement for the output of the bluesky Run Engine.

Parameters:
headersHeader or iterable of Headers

header or headers to fetch the documents for

fieldslist, optional

whitelist of field names of interest; if None, all are returned

fillbool, optional

Whether externally-stored data should be filled in. Defaults to False.

Yields:
name, doctuple

string name of the Document type and the Document itself. Example: (‘start’, {‘time’: …, …})

See also

Broker.process()

Examples

>>> def f(name, doc):
...     # do something
...
>>> h = db[-1]  # most recent header
>>> for name, doc in restream(h):
...     f(name, doc)