DatasetQueryResults¶
-
class
lsst.daf.butler.registry.queries.
DatasetQueryResults
¶ Bases:
collections.abc.Iterable
,typing.Generic
An interface for objects that represent the results of queries for datasets.
Methods Summary
byParentDatasetType
()Group results by parent dataset type. expanded
()Return a DatasetQueryResults
for whichDataCoordinate.hasResults
returnsTrue
for all data IDs in returnedDatasetRef
objects.materialize
()Insert this query’s results into a temporary table. Methods Documentation
-
byParentDatasetType
() → Iterator[lsst.daf.butler.registry.queries._results.ParentDatasetQueryResults]¶ Group results by parent dataset type.
Returns: - iter :
Iterator
[ParentDatasetQueryResults
] An iterator over
DatasetQueryResults
instances that are each responsible for a single parent dataset type (either just that dataset type, one or more of its component dataset types, or both).
- iter :
-
expanded
() → lsst.daf.butler.registry.queries._results.DatasetQueryResults¶ Return a
DatasetQueryResults
for whichDataCoordinate.hasResults
returnsTrue
for all data IDs in returnedDatasetRef
objects.Returns: - expanded :
DatasetQueryResults
Either a new
DatasetQueryResults
instance orself
, if it is already expanded.
Notes
As with
DataCoordinateQueryResults.expanded
, it may be more efficient to callmaterialize
before expanding data IDs for very large result sets.- expanded :
-
materialize
() → AbstractContextManager[lsst.daf.butler.registry.queries._results.DatasetQueryResults]¶ Insert this query’s results into a temporary table.
Returns: - context :
typing.ContextManager
[DatasetQueryResults
] A context manager that ensures the temporary table is created and populated in
__enter__
(returning a results object backed by that table), and dropped in__exit__
. Ifself
is already materialized, the context manager may do nothing (reflecting the fact that an outer context manager should already take care of everything else).
- context :
-