Cloud Datastore V1 Client - Class Aggregation (2.0.3)
Reference documentation and code samples for the Cloud Datastore V1 Client class Aggregation.
Defines an aggregation that produces a single result.
Generated from protobuf messagegoogle.datastore.v1.AggregationQuery.Aggregation
Namespace
Google \ Cloud \ Datastore \ V1 \ AggregationQueryMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ count | Aggregation\CountCount aggregator. |
↳ sum | Aggregation\SumSum aggregator. |
↳ avg | Aggregation\AvgAverage aggregator. |
↳ alias | stringOptional. Optional name of the property to store the result of the aggregation. If not provided, Datastore will pick a default name following the format |
getCount
Count aggregator.
| Returns | |
|---|---|
| Type | Description |
Aggregation\Count|null | |
hasCount
setCount
Count aggregator.
| Parameter | |
|---|---|
| Name | Description |
var | Aggregation\Count |
| Returns | |
|---|---|
| Type | Description |
$this | |
getSum
Sum aggregator.
| Returns | |
|---|---|
| Type | Description |
Aggregation\Sum|null | |
hasSum
setSum
Sum aggregator.
| Parameter | |
|---|---|
| Name | Description |
var | Aggregation\Sum |
| Returns | |
|---|---|
| Type | Description |
$this | |
getAvg
Average aggregator.
| Returns | |
|---|---|
| Type | Description |
Aggregation\Avg|null | |
hasAvg
setAvg
Average aggregator.
| Parameter | |
|---|---|
| Name | Description |
var | Aggregation\Avg |
| Returns | |
|---|---|
| Type | Description |
$this | |
getAlias
Optional. Optional name of the property to store the result of theaggregation.
If not provided, Datastore will pick a default name following the formatproperty_<incremental_id++>. For example:
AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT(*)OVER ( ...);becomes:
AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS property_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS property_2OVER ( ...);Requires:
- Must be unique across all aggregation aliases.
- Conform toentity propertyname limitations.
| Returns | |
|---|---|
| Type | Description |
string | |
setAlias
Optional. Optional name of the property to store the result of theaggregation.
If not provided, Datastore will pick a default name following the formatproperty_<incremental_id++>. For example:
AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT(*)OVER ( ...);becomes:
AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS property_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS property_2OVER ( ...);Requires:
- Must be unique across all aggregation aliases.
- Conform toentity propertyname limitations.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |
getOperator
| Returns | |
|---|---|
| Type | Description |
string | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-24 UTC.