YamlRepoImportBackend¶
- class lsst.daf.butler.YamlRepoImportBackend(stream: IO, butler: Butler)¶
Bases:
RepoImportBackend
A repository import implementation that reads from a YAML file.
- Parameters:
Methods Summary
load
(datastore, *[, directory, transfer, ...])Import information associated with the backend into the given registry and datastore.
register
()Register all runs and dataset types associated with the backend with the
Butler
the backend was constructed with.Methods Documentation
- load(datastore: Datastore | None, *, directory: ResourcePathExpression | None = None, transfer: str | None = None, skip_dimensions: set | None = None, record_validation_info: bool = True) None ¶
Import information associated with the backend into the given registry and datastore.
This must be run after
register
, and may be performed inside a transaction.- Parameters:
- datastore
Datastore
Datastore to import into. If
None
, datasets will only be inserted into theRegistry
(primarily intended for tests).- directory
ResourcePathExpression
, optional Directory all dataset paths are relative to.
- transfer
str
, optional Transfer mode forwarded to
Datastore.ingest
.- skip_dimensions
set
, optional Dimensions that should be skipped and not imported. This can be useful when importing into a registry that already knows about a specific instrument.
- record_validation_info
bool
, optional If
True
, the default, the datastore can record validation information associated with the file. IfFalse
the datastore will not attempt to track any information such as checksums or file sizes. This can be useful if such information is tracked in an external system or if the file is to be compressed in place. It is up to the underlying datastore whether this parameter is relevant.
- datastore