DataCoordinateQueryResults¶

class lsst.daf.butler.registry.queries.DataCoordinateQueryResults(db: Database, query_factory: Callable[[Iterable[str] | None, Tuple[int, int | None] | None], Query], graph: DimensionGraph, *, order_by: Iterable[str] | None = None, limit: Tuple[int, int | None] | None = None, records: Mapping[str, Mapping[tuple, DimensionRecord]] | None = None)¶

Bases: DataCoordinateIterable

An enhanced implementation of DataCoordinateIterable that represents data IDs retrieved from a database query.

Parameters:

dbDatabase: Database engine used to execute queries.
query_factoryQueryFactoryMethod: Method which creates an instance of Query class.
graphDimensionGraph: Dimensions used by query.
order_byIterable [ str ], optional: Optional sequence of column names used for result ordering.
limitTuple [ int, int ], optional: Limit for the number of returned records and optional offset.
recordsMapping, optional: A nested mapping containing DimensionRecord objects for all dimensions and all data IDs this query will yield. If None (default), DataCoordinateIterable.hasRecords will return False. The outer mapping has str keys (the names of dimension elements). The inner mapping has tuple keys representing data IDs (tuple conversions of DataCoordinate.values()) and DimensionRecord values.

Notes

Constructing an instance of this does nothing; the query is not executed until it is iterated over (or some other operation is performed that involves iteration).

Instances should generally only be constructed by Registry methods or the methods of other query result objects.

Attributes Summary

`graph`	Dimensions identified by these data IDs (`DimensionGraph`).
`universe`	Universe that defines all known compatible dimensions.

Methods Summary

`any`(*[, execute, exact])	Test whether this query returns any results.
`constrain`(query, columns)	Constrain a SQL query to include or relate to only known data IDs.
`count`(*[, exact])	Count the number of rows this query would return.
`expanded`()	Return a results object for which `hasRecords` returns `True`.
`explain_no_results`()	Return human-readable messages that may help explain why the query yields no results.
`findDatasets`(datasetType, collections, *[, ...])	Find datasets using the data IDs identified by this query.
`fromScalar`(dataId)	Return a `DataCoordinateIterable` containing the single data ID.
`from_query`(db, query, graph, *[, order_by, ...])	Make an instance from a pre-existing query instead of a factory.
`hasFull`()	Indicate if all data IDs in this iterable identify all dimensions.
`hasRecords`()	Return whether all data IDs in this iterable contain records.
`limit`(limit[, offset])	Make the iterator return limited number of records.
`materialize`()	Insert this query's results into a temporary table.
`order_by`(*args)	Make the iterator return ordered result.
`subset`([graph, unique])	Return a results object containing a subset of the dimensions of this one, and/or a unique near-subset of its rows.
`toSequence`()	Transform this iterable into a `DataCoordinateSequence`.
`toSet`()	Transform this iterable into a `DataCoordinateSet`.

Attributes Documentation

graph¶

universe¶

Universe that defines all known compatible dimensions.

(DimensionUniverse).

Methods Documentation

any(*, execute: bool = True, exact: bool = True) → bool¶

Test whether this query returns any results.

Parameters:

executebool, optional: If True, execute at least a LIMIT 1 query if it cannot be determined prior to execution that the query would return no rows.
exactbool, optional: If True, run the full query and perform post-query filtering if needed, until at least one result row is found. If False, the returned result does not account for post-query filtering, and hence may be True even when all result rows would be filtered out.

Returns:

anybool: True if the query would (or might, depending on arguments) yield result rows. False if it definitely would not.

constrain(query: SimpleQuery, columns: Callable[[str], ColumnElement]) → None¶

Constrain a SQL query to include or relate to only known data IDs.

Parameters:

querySimpleQuery: Struct that represents the SQL query to constrain, either by appending to its WHERE clause, joining a new table or subquery, or both.
columnsCallable: A callable that accepts str dimension names and returns SQLAlchemy objects representing a column for that dimension’s primary key value in the query.

count(*, exact: bool = True) → int¶

Count the number of rows this query would return.

Parameters:

exactbool, optional: If True, run the full query and perform post-query filtering if needed to account for that filtering in the count. If False, the result may be an upper bound.

Returns:

countint: The number of rows the query would return, or an upper bound if exact=False.

Notes

This counts the number of rows returned, not the number of unique rows returned, so even with exact=True it may provide only an upper bound on the number of deduplicated result rows.

expanded() → DataCoordinateQueryResults¶

Return a results object for which hasRecords returns True.

This method may involve actually executing database queries to fetch DimensionRecord objects.

Returns:

resultsDataCoordinateQueryResults: A results object for which hasRecords returns True. May be self if that is already the case.

Notes

For very result sets, it may be much more efficient to call materialize before calling expanded, to avoid performing the original query multiple times (as a subquery) in the follow-up queries that fetch dimension records. For example:

with registry.queryDataIds(...).materialize() as tempDataIds:
    dataIdsWithRecords = tempDataIds.expanded()
    for dataId in dataIdsWithRecords:
        ...

explain_no_results() → Iterator[str]¶

Return human-readable messages that may help explain why the query yields no results.

Returns:

messagesIterator [ str ]: String messages that describe reasons the query might not yield any results.

Notes

Messages related to post-query filtering are only available if the iterator has been exhausted, or if any or count was already called (with exact=True for the latter two).

This method first yields messages that are generated while the query is being built or filtered, but may then proceed to diagnostics generated by performing what should be inexpensive follow-up queries. Callers can short-circuit this at any time by simplying not iterating further.

findDatasets(datasetType: DatasetType | str, collections: Any, *, findFirst: bool = True) → DatasetQueryResults¶

Find datasets using the data IDs identified by this query.

Parameters:

datasetTypeDatasetType or str: Dataset type or the name of one to search for. Must have dimensions that are a subset of self.graph.
collectionsAny: An expression that fully or partially identifies the collections to search for the dataset, such as a str, re.Pattern, or iterable thereof. ... can be used to return all collections. See Collection expressions for more information.
findFirstbool, optional: If True (default), for each result data ID, only yield one DatasetRef, from the first collection in which a dataset of that dataset type appears (according to the order of collections passed in). If True, collections must not contain regular expressions and may not be ....

Returns:

datasetsDatasetQueryResults: A lazy-evaluation object representing dataset query results, iterable over DatasetRef objects. If self.hasRecords(), all nested data IDs in those dataset references will have records as well.

Raises:

ValueError: Raised if datasetType.dimensions.issubset(self.graph) is False.

static fromScalar(dataId: DataCoordinate) → _ScalarDataCoordinateIterable¶

Return a DataCoordinateIterable containing the single data ID.

Parameters:

dataIdDataCoordinate: Data ID to adapt. Must be a true DataCoordinate instance, not an arbitrary mapping. No runtime checking is performed.

Returns:

iterableDataCoordinateIterable: A DataCoordinateIterable instance of unspecified (i.e. implementation-detail) subclass. Guaranteed to implement the collections.abc.Sized (i.e. __len__) and collections.abc.Container (i.e. __contains__) interfaces as well as that of DataCoordinateIterable.

classmethod from_query(db: Database, query: Query, graph: DimensionGraph, *, order_by: Iterable[str] | None = None, limit: Tuple[int, int | None] | None = None, records: Mapping[str, Mapping[tuple, DimensionRecord]] | None = None) → DataCoordinateQueryResults¶

Make an instance from a pre-existing query instead of a factory.

Parameters:

dbDatabase: Database engine used to execute queries.
queryQuery: Low-level representation of the query that backs this result object.
graphDimensionGraph: Dimensions used by query.
order_byIterable [ str ], optional: Optional sequence of column names used for result ordering.
limitTuple [ int, int ], optional: Limit for the number of returned records and optional offset.
recordsMapping, optional: A nested mapping containing DimensionRecord objects for all dimensions and all data IDs this query will yield. If None (default), DataCoordinateIterable.hasRecords will return False. The outer mapping has str keys (the names of dimension elements). The inner mapping has tuple keys representing data IDs (tuple conversions of DataCoordinate.values()) and DimensionRecord values.

hasFull() → bool¶

Indicate if all data IDs in this iterable identify all dimensions.

Not just required dimensions.

Returns:

statebool: If True, all(d.hasFull() for d in iterable) is guaranteed. If False, no guarantees are made.

hasRecords() → bool¶

Return whether all data IDs in this iterable contain records.

Returns:

statebool: If True, all(d.hasRecords() for d in iterable) is guaranteed. If False, no guarantees are made.

limit(limit: int, offset: int | None = None) → DataCoordinateQueryResults¶

Make the iterator return limited number of records.

Parameters:

limitint: Upper limit on the number of returned records.
offsetint or None: If not None then the number of records to skip before returning limit records.

Returns:

resultDataCoordinateQueryResults: Returns self instance which is updated to return limited set of records.

Notes

This method modifies the iterator in place and returns the same instance to support method chaining. Normally this method is used together with order_by method.

materialize() → Iterator[DataCoordinateQueryResults]¶

Insert this query’s results into a temporary table.

Returns:

contexttyping.ContextManager [ DataCoordinateQueryResults ]: 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__. If self is already materialized, the context manager may do nothing (reflecting the fact that an outer context manager should already take care of everything else).

Notes

When using a very large result set to perform multiple queries (e.g. multiple calls to subset with different arguments, or even a single call to expanded), it may be much more efficient to start by materializing the query and only then performing the follow up queries. It may also be less efficient, depending on how well database engine’s query optimizer can simplify those particular follow-up queries and how efficiently it caches query results even when the are not explicitly inserted into a temporary table. See expanded and subset for examples.

order_by(*args: str) → DataCoordinateQueryResults¶

Make the iterator return ordered result.

Parameters:

*argsstr: Names of the columns/dimensions to use for ordering. Column name can be prefixed with minus (-) to use descending ordering.

Returns:

resultDataCoordinateQueryResults: Returns self instance which is updated to return ordered result.

Notes

This method modifies the iterator in place and returns the same instance to support method chaining.

subset(graph: DimensionGraph | None = None, *, unique: bool = False) → DataCoordinateQueryResults¶

Return a results object containing a subset of the dimensions of this one, and/or a unique near-subset of its rows.

This method may involve actually executing database queries to fetch DimensionRecord objects.

Parameters:

graphDimensionGraph, optional: Dimensions to include in the new results object. If None, self.graph is used.
uniquebool, optional: If True (False is default), the query should only return unique data IDs. This is implemented in the database; to obtain unique results via Python-side processing (which may be more efficient in some cases), use toSet to construct a DataCoordinateSet from this results object instead.

Returns:

resultsDataCoordinateQueryResults: A results object corresponding to the given criteria. May be self if it already qualifies.

Raises:

ValueError: Raised when graph is not a subset of the dimension graph in this result.

Notes

This method can only return a “near-subset” of the original result rows in general because of subtleties in how spatial overlaps are implemented; see Query.subset for more information.

When calling subset multiple times on the same very large result set, it may be much more efficient to call materialize first. For example:

dimensions1 = DimensionGraph(...)
dimensions2 = DimensionGraph(...)
with registry.queryDataIds(...).materialize() as tempDataIds:
    for dataId1 in tempDataIds.subset(
            graph=dimensions1,
            unique=True):
        ...
    for dataId2 in tempDataIds.subset(
            graph=dimensions2,
            unique=True):
        ...

toSequence() → DataCoordinateSequence¶

Transform this iterable into a DataCoordinateSequence.

Returns:

seqDataCoordinateSequence: A new DatasetCoordinateSequence with the same elements as self, in the same order. May be self if it is already a DataCoordinateSequence.

toSet() → DataCoordinateSet¶

Transform this iterable into a DataCoordinateSet.

Returns:

setDataCoordinateSet: A DatasetCoordinateSet instance with the same elements as self, after removing any duplicates. May be self if it is already a DataCoordinateSet.

Navigation

DataCoordinateQueryResults¶