U $FZh%@sdZddlmZddlmZmZmZmZmZm Z ddl m Z m Z ddl m ZddlmZmZmZddlmZddlmZerdd lmZdd lmZdd lmZGd d d eZdS)aUClasses for representing aggregation queries for the Google Cloud Firestore API. A :class:`~google.cloud.firestore_v1.aggregation.AggregationQuery` can be created directly from a :class:`~google.cloud.firestore_v1.collection.Collection` and that can be a more common way to create an aggregation query than direct usage of the constructor. ) annotations) TYPE_CHECKINGAny GeneratorListOptionalUnion) exceptionsgapic_v1)retry)AggregationResultBaseAggregationQuery_query_response_to_result)QueryResultsList)StreamGenerator) transaction)ExplainMetrics)ExplainOptionscseZdZdZddfdd Zdejjdfdddd d d d d dZdddZ ddZ dejjddfdddd ddddZ dejjdfdddddd ddddZ Z S)AggregationQueryz5Represents an aggregation query to the Firestore API.None)returncstt||dS)N)superr__init__)selfZ nested_query __class__l/home/aprabhat/apps/x.techxrdev.in/venv/lib/python3.8/site-packages/google/cloud/firestore_v1/aggregation.pyr.szAggregationQuery.__init__N)explain_optionsz"Union[retries.Retry, None, object]z float | NonezOptional[ExplainOptions]z#QueryResultsList[AggregationResult])r timeoutrrcCs@d}|j||||d}t|}|dkr,d}n|}t|||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[AggregationResult]: The aggregation query results. Nrr rr)streamlistZget_explain_metricsr)rrr rrexplain_metricsresultZ result_listrrrget4s"zAggregationQuery.getcCs2|||||\}}|jjjf||jjd|S)!Helper method for :meth:`stream`.)requestmetadata)Z _prep_stream_client_firestore_apirun_aggregation_queryZ _rpc_metadata)rrr rrr'kwargsrrr_get_stream_iteratorgs z%AggregationQuery._get_stream_iteratorcCs8|dkr4|tjjkr*|jjj}|j}|j}||SdS)r&NF) r methodDEFAULTr)r*Z _transportr+Z_retryZ _predicate)rexcr r transportZgapic_callablerrr_retry_query_after_exceptionvs   z-AggregationQuery._retry_query_after_exceptionz!Optional[transaction.Transaction]zOptional[float]zAGenerator[List[AggregationResult], Any, Optional[ExplainMetrics]])rr rrrc csd}|||||}zt|d}WnLtjk rn}z,||||r\||||}WY qnW5d}~XYnX|dkrzq|dkr|jr|j}t|} | r| Vq|S)aInternal 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 this 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]: The result of aggregations of this query. Returns: (Optional[google.cloud.firestore_v1.types.query_profile.ExplainMetrtics]): The results of query profiling, if received from the service. N)r-nextr ZGoogleAPICallErrorr2r#r) rrr rrZmetricsZresponse_iteratorresponser0r$rrr _make_streams4' zAggregationQuery._make_streamz#Optional['transaction.Transaction']z(StreamGenerator[List[AggregationResult]]cCs|j||||d}t||S)aRuns 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 this 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 (Optinal[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: `StreamGenerator[List[AggregationResult]]`: A generator of the query results. r )r5r)rrr rrZinner_generatorrrrr!s#zAggregationQuery.stream)N)__name__ __module__ __qualname____doc__rr r.r/r%r-r2r5r! __classcell__rrrrr+s*3  KrN)r9 __future__rtypingrrrrrrZgoogle.api_corer r r retriesZ*google.cloud.firestore_v1.base_aggregationr r rZ'google.cloud.firestore_v1.query_resultsrZ*google.cloud.firestore_v1.stream_generatorrZgoogle.cloud.firestore_v1rZ'google.cloud.firestore_v1.query_profilerrrrrrrs