U >i!@sdZddlmZddlmZmZmZmZmZm Z ddl m Z ddl m Z ddlmZddlmZddlmZmZdd lmZerdd lmZdd lmZmZdd lmmmmZ Gd ddeZ!d S)aqClasses for representing Async aggregation queries for the Google Cloud Firestore API. A :class:`~google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery` can be created directly from a :class:`~google.cloud.firestore_v1.async_collection.AsyncCollection` and that can be a more common way to create an aggregation query than direct usage of the constructor. ) annotations) TYPE_CHECKINGAnyAsyncGeneratorListOptionalUnion)gapic_v1) retry_async) transaction)AsyncStreamGenerator)BaseAggregationQuery_query_response_to_result)QueryResultsList)AggregationResult)ExplainMetricsExplainOptionsNcseZdZdZddfdd Zdejjdfdddd d d d d dZdejjddfdddd ddddZ dejjdfdddddd ddddZ Z S)AsyncAggregationQueryz5Represents an aggregation query to the Firestore API.None)returncstt||dSN)superr__init__)selfZ nested_query __class__O/tmp/pip-unpacked-wheel-599y42ri/google/cloud/firestore_v1/async_aggregation.pyr-szAsyncAggregationQuery.__init__N)explain_optionsz'Union[retries.AsyncRetry, None, object]z float | NonezOptional[ExplainOptions]z)QueryResultsList[List[AggregationResult]])retrytimeoutrrcshd}|j||||d}z4dd|2IdH}|dkr:d}n|IdH}W5|IdHXt|||S)aRuns the aggregation query. This sends a ``RunAggregationQuery`` RPC and returns a list of aggregation results in the stream of ``RunAggregationQueryResponse`` messages. Args: transaction (Optional[:class:`~google.cloud.firestore_v1.transaction.Transaction`]): An existing transaction that this query will run in. If a ``transaction`` is used and it already has write operations added, this method cannot be used (i.e. read-after-write is not allowed). retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. Defaults to a system-specified policy. timeout (float): The timeout for this request. Defaults to a system-specified value. explain_options (Optional[:class:`~google.cloud.firestore_v1.query_profile.ExplainOptions`]): Options to enable query profiling for this query. When set, explain_metrics will be available on the returned generator. Returns: QueryResultsList[List[AggregationResult]]: The aggregation query results. Nr rr rcsg|z3dHW}|q6Srr).0Z aggregationrrr \sz-AsyncAggregationQuery.get..)streamacloseZget_explain_metricsr)rr rr rexplain_metricsZ stream_resultresultrrrget3s zAsyncAggregationQuery.getz!Optional[transaction.Transaction]z"retries.AsyncRetry | object | NonezOptional[float]zNAsyncGenerator[List[AggregationResult] | query_profile_pb.ExplainMetrics, Any])r rr rrc Cst|||||\}}|jjjf||jjd|IdH}|2z03dHW}t|} | rZ| V|jr<|j} | Vq<6dS)a Internal method for stream(). Runs the aggregation query. This sends a ``RunAggregationQuery`` RPC and then returns a generator which consumes each document returned in the stream of ``RunAggregationQueryResponse`` messages. If a ``transaction`` is used and it already has write operations added, this method cannot be used (i.e. read-after-write is not allowed). Args: transaction (Optional[:class:`~google.cloud.firestore_v1.transaction. Transaction`]): An existing transaction that the query will run in. retry (Optional[google.api_core.retry.Retry]): Designation of what errors, if any, should be retried. Defaults to a system-specified policy. timeout (Optional[float]): The timeout for this request. Defaults to a system-specified value. explain_options (Optional[:class:`~google.cloud.firestore_v1.query_profile.ExplainOptions`]): Options to enable query profiling for this query. When set, explain_metrics will be available on the returned generator. Yields: List[AggregationResult] | query_profile_pb.ExplainMetrics: The result of aggregations of this query. Query results will be yielded as `List[AggregationResult]`. When the result contains returned explain metrics, yield `query_profile_pb.ExplainMetrics` individually. )requestmetadataN)Z _prep_streamZ_clientZ_firestore_apiZrun_aggregation_queryZ _rpc_metadatarr&) rr rr rr)kwargsZresponse_iteratorresponser'Zmetricsrrr _make_streamgs&&  z"AsyncAggregationQuery._make_streamz-AsyncStreamGenerator[List[AggregationResult]]cCs|j||||d}t||S)a Runs the aggregation query. This sends a ``RunAggregationQuery`` RPC and then returns a generator which consumes each document returned in the stream of ``RunAggregationQueryResponse`` messages. If a ``transaction`` is used and it already has write operations added, this method cannot be used (i.e. read-after-write is not allowed). Args: transaction (Optional[:class:`~google.cloud.firestore_v1.transaction. Transaction`]): An existing transaction that the query will run in. retry (Optional[google.api_core.retry.Retry]): Designation of what errors, if any, should be retried. Defaults to a system-specified policy. timeout (Optional[float]): The timeout for this request. Defaults to a system-specified value. explain_options (Optional[:class:`~google.cloud.firestore_v1.query_profile.ExplainOptions`]): Options to enable query profiling for this query. When set, explain_metrics will be available on the returned generator. Returns: `AsyncStreamGenerator[List[AggregationResult]]`: A generator of the query results. r!)r-r )rr rr rZinner_generatorrrrr$s$zAsyncAggregationQuery.stream) __name__ __module__ __qualname____doc__rr methodDEFAULTr(r-r$ __classcell__rrrrr*s&6>r)"r1 __future__rtypingrrrrrrZgoogle.api_corer r retriesZgoogle.cloud.firestore_v1r Z0google.cloud.firestore_v1.async_stream_generatorr Z*google.cloud.firestore_v1.base_aggregationr rZ'google.cloud.firestore_v1.query_resultsrrZ'google.cloud.firestore_v1.query_profilerrZ-google.cloud.firestore_v1.types.query_profileZcloudZ firestore_v1typesZ query_profileZquery_profile_pbrrrrrs