Reference documentation and code samples for the Cloud Datastore Client class Aggregation.

Represents Aggregation properties.

Example:

$count = Aggregation::count();$count->alias('count');$count->limit(100);echo json_encode($count->getProps());

Aggregations considers non existing property name as an empty query set

Set the aggregation alias.

Example:

$count = Aggregation->count();$count->alias('total');echo $count->props()['count']['alias'];

Get the array representation for the aggregation.

Creates count aggregation properties.

Example:

$count = Aggregation::count();

Creates sum aggregation properties.

Example:

$sum = Aggregate::sum('property_to_aggregate_upon');

Result of SUM aggregation can be a integer or a float.Sum of integers which exceed maxinum integer value returns a float.Sum of numbers exceeding max float value returnsINF.Sum of data which containsNaN returnsNaN.Non numeric values are ignored.

Creates average aggregation properties.

Example:

$avg = Aggregate::avg('property_to_aggregate_upon');

Result of AVG aggregation can be a float or a null.Average of empty valid data set returnnull.Average of numbers exceeding max float value returnsINF.Average of data which containsNaN returnsNaN.Non numeric values are ignored.