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
Namespace
Google \ Cloud \ Firestore \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ structured_query |
Google\Cloud\Firestore\V1\StructuredQuery
Nested structured query. |
↳ aggregations |
array<Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation>
Optional. Series of aggregations to apply over the results of the |
getStructuredQuery
Nested structured query.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\StructuredQuery|null |
|
hasStructuredQuery
setStructuredQuery
Nested structured query.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\StructuredQuery
|
| 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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 |
var |
array<Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQueryType
| Returns | |
|---|---|
| Type | Description |
string |
|