Cloud Datastore Client - Class AggregationQueryResult (1.33.0)

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

Represents the result of an Aggregation Query

Example:

use Google\Cloud\Datastore\DatastoreClient;

$datastore = new DatastoreClient();

$query = $datastore->AggregationQuery();
$query->kind('Companies');
$query->filter('companyName', '=', 'Google');
$query->limit(100);
$query->addAggregation(Aggregation::count()->alias('total_upto_100'));

$res = $datastore->runAggregationQuery($query);
echo $res->get('total_upto_100');

Namespace

Google \ Cloud \ Datastore \ Query

Methods

__construct

Create AggregationQueryResult object.

Parameters
Name Description
result array

Response of RunAggregationQuery
mapper Google\Cloud\Datastore\EntityMapper

[Optional] Entity mapper to map datastore values to their equivalent php values incase of null, NAN, INF and -INF

get

Get the Query Aggregation value.

Example:

$query = $datastore->AggregationQuery();
$query->kind('Companies');
$query->filter('companyName', '=', 'Google');
$query->addAggregation(Aggregation::count()->alias('total'));
$res = $client->runAggregationQuery($query);
echo $res->get('total');
Parameter
Name Description
alias string

The aggregation alias.
Returns
Type Description
mixed

getQuery

Gets the value of query for example in case of a GqlQuery.

Returns
Type Description
AggregationQuery

getTransaction

Gets the transaction id when Aggregation is associated with a Transaction.

Returns
Type Description
string|null

getReadTime

Gets the timestamp when Aggregation was executed.

Returns
Type Description
Google\Cloud\Core\Timestamp

getExplainMetrics

Gets the ExplainMetrics object if the explainOptions parameter was set for the query

Returns
Type Description
null|Google\Cloud\Datastore\V1\ExplainMetrics