o  i!@sdZddlmZddlmZmZmZmZmZm Z ddl m Z ddl m Z ddlmZddlmZddlmZmZdd lmZer]dd 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)ExplainMetricsExplainOptionsNcsreZdZdZdfdd ZdejjdfdddddZdejjddfdddZ dejjdfdddddZ Z S)AsyncAggregationQueryz5Represents an aggregation query to the Firestore API.returnNonecstt||dSN)superr__init__)self nested_query __class__/var/www/snowflake_co_dev_github/snow_flake_back_end_deploy/env/lib/python3.10/site-packages/google/cloud/firestore_v1/async_aggregation.pyr-szAsyncAggregationQuery.__init__N)explain_optionsretry'Union[retries.AsyncRetry, None, object]timeout float | NonerOptional[ExplainOptions])QueryResultsList[List[AggregationResult]]csxd}|j||||d}z!dd|2IdH}|durd}n|IdH}W|IdHn|IdHwt|||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 r r"rcsg|z3dHW}|q6Srr).0 aggregationrrr \sz-AsyncAggregationQuery.get..)streamget_explain_metricsacloser)rr r r"rexplain_metrics stream_resultresultrrrget3s    zAsyncAggregationQuery.getr !Optional[transaction.Transaction]"retries.AsyncRetry | object | NoneOptional[float]NAsyncGenerator[List[AggregationResult] | query_profile_pb.ExplainMetrics, Any]c Csv|||||\}}|jjjd||jjd|IdH}|2z3dHW}t|} | r.| V|jr7|j} | Vq6dS)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. )requestmetadataNr) _prep_stream_client_firestore_apirun_aggregation_query _rpc_metadatarr-) rr r r"rr5kwargsresponse_iteratorresponser/metricsrrr _make_streamgs,&  z"AsyncAggregationQuery._make_stream-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 r r"rinner_generatorrrrr*s$ zAsyncAggregationQuery.stream)rr)r r!r"r#rr$rr%) r r1r r2r"r3rr$rr4) r r1r r2r"r3rr$rrA) __name__ __module__ __qualname____doc__rr methodDEFAULTr0r@r* __classcell__rrrrr*s(6 >r)"rF __future__rtypingrrrrrrgoogle.api_corer r retriesgoogle.cloud.firestore_v1r 0google.cloud.firestore_v1.async_stream_generatorr *google.cloud.firestore_v1.base_aggregationr r'google.cloud.firestore_v1.query_resultsrr'google.cloud.firestore_v1.query_profilerr-google.cloud.firestore_v1.types.query_profilecloud firestore_v1types query_profilequery_profile_pbrrrrrs