Reference documentation and code samples for the Cloud Datastore V1 Client class AggregationResult.
The result of a single bucket from a Datastore aggregation query.
The keys of aggregate_properties are the same for all results in an
aggregation query, unlike entity queries which can have different fields
present for each result.
Generated from protobuf message google.datastore.v1.AggregationResult
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ aggregate_properties |
array|Google\Protobuf\Internal\MapField
The result of the aggregation functions, ex: |
getAggregateProperties
The result of the aggregation functions, ex: COUNT(*) AS total_entities.
The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.
Generated from protobuf field map<string, .google.datastore.v1.Value> aggregate_properties = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setAggregateProperties
The result of the aggregation functions, ex: COUNT(*) AS total_entities.
The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.
Generated from protobuf field map<string, .google.datastore.v1.Value> aggregate_properties = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |