QuerySummary¶
- class lsst.daf.butler.registry.queries.QuerySummary(requested: DimensionGroup, *, column_types: ColumnTypeInfo, data_id: DataCoordinate | None = None, expression: str = '', region: Region | None = None, bind: Mapping[str, Any] | None = None, defaults: DataCoordinate | None = None, datasets: Iterable[DatasetType] = (), order_by: Iterable[str] | None = None, limit: tuple[int, int | None] | None = None, check: bool = True)¶
Bases:
object
A struct that holds and categorizes the dimensions involved in a query.
A
QuerySummary
instance is necessary to construct aQueryBuilder
, and it needs to include all of the dimensions that will be included in the query (including any needed for querying datasets).- Parameters:
- requested
DimensionGroup
The dimensions whose primary keys should be included in the result rows of the query.
- column_types
ColumnTypeInfo
Information about column types.
- data_id
DataCoordinate
, optional A fully-expanded data ID identifying dimensions known in advance. If not provided, will be set to an empty data ID.
- expression
str
, optional A user-provided string WHERE expression.
- region
lsst.sphgeom.Region
, optional A spatial constraint that all rows must overlap.
- bind
Mapping
[str
,object
], optional Mapping containing literal values that should be injected into the query expression, keyed by the identifiers they replace.
- defaults
DataCoordinate
, optional A data ID containing default for governor dimensions.
- datasets
Iterable
[DatasetType
], optional Dataset types whose searches may be joined into the query. Callers must still call
QueryBuilder.joinDataset
explicitly to control how that join happens (e.g. which collections are searched), but by declaring them here first we can ensure that the query includes the right dimensions for those joins.- order_by
Iterable
[str
] Sequence of names to use for ordering with optional “-” prefix.
- limit
Tuple
, optional Limit on the number of returned rows and optional offset.
- check
bool
, optional If
False
, permit expressions to refer to dimensions without providing a value for their governor dimensions (e.g. referring to a visit without an instrument). Should be left to default toTrue
in essentially all new code.
- requested
Attributes Summary
All known dimensions (
DimensionUniverse
).Attributes Documentation
- universe¶
All known dimensions (
DimensionUniverse
).