Module aggregation (2.20.0)

API documentation for datastore.aggregation module.

Classes

AggregationQuery

AggregationQuery(client, query, explain_options=None)

An Aggregation query against the Cloud Datastore.

This class serves as an abstraction for creating aggregations over query in the Cloud Datastore.

Parameters
Name	Description
`client`	`Client` The client used to connect to Datastore.
`query`	`Query` The query used for aggregations.
`explain_options`	`ExplainOptions` (Optional) Options to enable query profiling for this query. When set, explain_metrics will be available on the iterator returned by query.fetch(). If not passed, will use value from given query.

AggregationResult

AggregationResult(alias, value)

A class representing result from Aggregation Query

Parameters
Name	Description
`alias`	`str` The alias for the aggregation.
`value`	`int` The resulting value from the aggregation.

AggregationResultIterator

AggregationResultIterator(
    aggregation_query,
    client,
    limit=None,
    eventual=False,
    retry=None,
    timeout=None,
    read_time=None,
)

Represent the state of a given execution of a Query.

Parameters
Name	Description
`aggregation_query`	`AggregationQuery` AggregationQuery object holding permanent configuration (i.e. things that don't change on with each page in a results set).
`client`	`Client` The client used to make a request.
`eventual`	`bool` (Optional) Defaults to strongly consistent (False). Setting True will use eventual consistency, but cannot be used inside a transaction or with read_time, otherwise will raise ValueError.
`retry`	`google.api_core.retry.Retry` A retry object used to retry requests. If `None` is specified, requests will be retried using a default configuration.
`timeout`	`float` Time, in seconds, to wait for the request to complete. Note that if `retry` is specified, the timeout applies to each individual attempt.
`read_time`	`datetime` (Optional) Runs the query with read time consistency. Cannot be used with eventual consistency or inside a transaction, otherwise will raise ValueError. This feature is in private preview.

AvgAggregation

AvgAggregation(property_ref, alias=None)

Representation of a "Avg" aggregation query.

Parameters
Name	Description
`property_ref`	`str` The property_ref for the aggregation.
`value`	`int` The resulting value from the aggregation.

BaseAggregation

BaseAggregation(alias=None)

Base class representing an Aggregation operation in Datastore

CountAggregation

CountAggregation(alias=None)

Representation of a "Count" aggregation query.

Parameters
Name	Description
`alias`	`str` The alias for the aggregation.
`value`	`int` The resulting value from the aggregation.

SumAggregation

SumAggregation(property_ref, alias=None)

Representation of a "Sum" aggregation query.

Parameters
Name	Description
`property_ref`	`str` The property_ref for the aggregation.
`value`	`int` The resulting value from the aggregation.