Cloud Firestore Client - Class Aggregate (1.46.0)

Reference documentation and code samples for the Cloud Firestore Client class Aggregate.

Represents Aggregate properties.

Example:

$count = Aggregate::count();
$count->alias('count');

echo json_encode($count->getProps());

Set the aggregate alias.

Example:

$count = Aggregate->count();
$count->alias('total');

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

Get the array representation for the aggregate.

Creates count aggregation properties.

Example:

$count = Aggregate::count();

Creates sum aggregation properties.

Example:

$sum = Aggregate::sum('field_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 returns INF. Sum of data which contains NaN returns NaN. Non numeric values are ignored.

Creates average aggregation properties.

Example:

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

Result of AVG aggregation can be a float or a null. Average of empty valid data set return null. Average of numbers exceeding max float value returns INF. Average of data which contains NaN returns NaN. Non numeric values are ignored.