databroker.Broker.export

Broker.export(self, headers, db, new_root=None, copy_kwargs=None)[source]

Serialize a list of runs.

If a new_root is passed files associated with the run will be moved to this new location, and the corresponding resource document will be updated with the new_root.

Parameters
headersdatabroker.header

one or more run headers that are going to be exported

dbdatabroker.Broker

an instance of databroker.Broker class that will be the target to export info

new_rootstr

optional. root directory of files that are going to be exported

copy_kwargsdict or None

passed through to the copy_files method on Registry; None by default

Returns
——
file_pairslist

list of (old_file_path, new_file_path) pairs generated by copy_files method on Registry.