Some or all of the information on this page might not apply to Trusted Cloud by S3NS. See Differences from Google Cloud for more details.

Google Cloud Datastore v1 API - Class AggregationQueryResults (4.15.0)

public sealed class AggregationQueryResults

Reference documentation and code samples for the Google Cloud Datastore v1 API class AggregationQueryResults.

Represents the result of an AggregationQuery.

Inheritance

object > AggregationQueryResults

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Datastore.V1

Assembly

Google.Cloud.Datastore.V1.dll

Properties

this[string]

public Value this[string alias] { get; }

Returns the result of the aggregation function that is assigned to the given alias. Will be null if was not specified in the original query.

Parameter
Name	Description
`alias`	`string` The alias of the aggregation function that was provided in the aggregation query. If not provided, Datastore will pick a default name following the format `property_<incremental_id++>`. For example: `text` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) OVER ( ... ); ``` becomes: ```text ``` 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_UP_TO(4) AS property_2 OVER ( ... );

Parameter

Name Description

alias

string

The alias of the aggregation function that was provided in the aggregation query. If not provided, Datastore will pick a default name following the format property_<incremental_id++>. For example: text AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) OVER ( ... ); ```

 becomes:
 ```text
 ```
 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_UP_TO(4) AS property_2
 OVER (
   ...
 );

Property Value
Type	Description
`Value`	The result of the aggregation function corresponding to the given alias.

Metrics

public ExplainMetrics Metrics { get; }

The information about planning and execution (if any) of the query. This will be null if no analysis was requested.

Property Value
Type	Description
`ExplainMetrics`

MoreResults

public QueryResultBatch.Types.MoreResultsType MoreResults { get; }

The condition that caused the query to complete, indicating whether more results are available beyond the query limit or end cursor, or whether the data has been exhausted.

Property Value
Type	Description
`QueryResultBatchTypesMoreResultsType`

ReadTime

public Timestamp ReadTime { get; }

The time at which the snapshot was read. This will be null if the query was only planned, and not executed.

Property Value
Type	Description
`Timestamp`