Reference documentation and code samples for the Cloud Datastore V1 Client class AggregationQuery.
Datastore query for running an aggregation over a Query.
Generated from protobuf message google.datastore.v1.AggregationQuery
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ nested_query |
Google\Cloud\Datastore\V1\Query
Nested query for aggregation |
↳ aggregations |
array<Google\Cloud\Datastore\V1\AggregationQuery\Aggregation>
Optional. Series of aggregations to apply over the results of the |
getNestedQuery
Nested query for aggregation
Generated from protobuf field .google.datastore.v1.Query nested_query = 1;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Datastore\V1\Query|null | |
hasNestedQuery
setNestedQuery
Nested query for aggregation
Generated from protobuf field .google.datastore.v1.Query nested_query = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Datastore\V1\Query
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAggregations
Optional. Series of aggregations to apply over the results of the nested_query.
Requires:
- A minimum of one and maximum of five aggregations per query.
Generated from protobuf field repeated .google.datastore.v1.AggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setAggregations
Optional. Series of aggregations to apply over the results of the nested_query.
Requires:
- A minimum of one and maximum of five aggregations per query.
Generated from protobuf field repeated .google.datastore.v1.AggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Datastore\V1\AggregationQuery\Aggregation>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryType
| Returns | |
|---|---|
| Type | Description |
string | |