Reference documentation and code samples for the Cloud Firestore V1 Client class StructuredAggregationQuery.
Firestore query for running an aggregation over a StructuredQuery .
Generated from protobuf message google.firestore.v1.StructuredAggregationQuery
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ structured_query
↳ aggregations
array< Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation
>
Optional. Series of aggregations to apply over the results of the structured_query
. Requires: * A minimum of one and maximum of five aggregations per query.
getStructuredQuery
Nested structured query.
hasStructuredQuery
setStructuredQuery
Nested structured query.
Returns
Type
Description
$this
getAggregations
Optional. Series of aggregations to apply over the results of the structured_query
.
Requires:
- A minimum of one and maximum of five aggregations per query.
setAggregations
Optional. Series of aggregations to apply over the results of the structured_query
.
Requires:
- A minimum of one and maximum of five aggregations per query.
Parameter
Name
Description
Returns
Type
Description
$this
getQueryType
Returns
Type
Description
string
