Reference documentation and code samples for the Cloud Datastore V1 Client class Aggregation.
Defines an aggregation that produces a single result.
Generated from protobuf message google.datastore.v1.AggregationQuery.Aggregation
Namespace
Google \ Cloud \ Datastore \ V1 \ AggregationQueryMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ count
↳ sum
↳ avg
↳ alias
string
Optional. Optional name of the property to store the result of the aggregation. If not provided, Datastore will pick a default name following the format property_<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_2 OVER ( ... );
Requires: * * Must be unique across all aggregation aliases. * * Conform to entity property name
limitations.
getCount
Count aggregator.
hasCount
setCount
Count aggregator.
$this
getSum
Sum aggregator.
hasSum
setSum
Sum aggregator.
$this
getAvg
Average aggregator.
hasAvg
setAvg
Average aggregator.
$this
getAlias
Optional. Optional name of the property to store the result of the aggregation.
If not provided, Datastore will pick a default name following the format property_<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_2
OVER (
...
);
Requires:
- Must be unique across all aggregation aliases.
- Conform to entity property name limitations.
string
setAlias
Optional. Optional name of the property to store the result of the aggregation.
If not provided, Datastore will pick a default name following the format property_<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_2
OVER (
...
);
Requires:
- Must be unique across all aggregation aliases.
- Conform to entity property name limitations.
var
string
$this
getOperator
string
