o ,= j+@sdZddlmZddlmZmZmZmZmZm Z ddl m Z m Z ddl m ZddlmZmZmZddlmZddlmZerPdd lZdd lmZdd lmZmZGd d d eZd S)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)StreamGeneratorN) transaction)ExplainMetricsExplainOptionscseZdZdZd!fdd Zdejjdfdddd"ddZ d#ddZ ddZ dejjdddfd$ddZ dejjdfdddd%dd Z Z S)&AggregationQueryz5Represents an aggregation query to the Firestore API.returnNonecstt||dS)N)superr__init__)selfZ nested_query __class__oC:\Users\psant\Downloads\Anu Raj Backend\school\venv\Lib\site-packages\google/cloud/firestore_v1/aggregation.pyr0szAggregationQuery.__init__N)explain_options read_timer "Union[retries.Retry, None, object]timeout float | NonerOptional[ExplainOptions]rOptional[datetime.datetime]#QueryResultsList[AggregationResult]c CsBd}|j|||||d}t|}|durd}n|}t|||S)aPRuns 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. read_time (Optional[datetime.datetime]): If set, reads documents as they were at the given time. This must be a timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. If no timezone is specified in the :class:`datetime.datetime` object, it is assumed to be UTC. Returns: QueryResultsList[AggregationResult]: The aggregation query results. Nrr r!rr)streamlistZget_explain_metricsr) rrr r!rrexplain_metricsresultZ result_listrrrget6s% zAggregationQuery.getcCs4||||||\}}|jjjd||jjd|S)!Helper method for :meth:`stream`.)requestmetadataNr)Z _prep_stream_client_firestore_apirun_aggregation_queryZ _rpc_metadata)rrr r!rrr-kwargsrrr_get_stream_iteratorms z%AggregationQuery._get_stream_iteratorcCs8|dur|tjjur|jjj}|j}|j}||SdS)r,NF) r methodDEFAULTr/r0 _transportr1Z_retryZ _predicate)rexcr r transportZgapic_callablerrr_retry_query_after_exceptions   z-AggregationQuery._retry_query_after_exceptionr!Optional[transaction.Transaction]Optional[float]AGenerator[List[AggregationResult], Any, Optional[ExplainMetrics]]c csd}||||||} zt|d}Wn$tjy8} z|| ||r3||||||}WYd} ~ q d} ~ ww|dur@ |S|durJ|jrJ|j}t|} | rS| Vq )aIInternal 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. read_time (Optional[datetime.datetime]): If set, reads documents as they were at the given time. This must be a timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. If no timezone is specified in the :class:`datetime.datetime` object, it is assumed to be UTC. 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. NT)r3nextr ZGoogleAPICallErrorr9r)r) rrr r!rrZmetricsZresponse_iteratorresponser7r*rrr _make_streamsD*   zAggregationQuery._make_stream#Optional['transaction.Transaction'](StreamGenerator[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 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. read_time (Optional[datetime.datetime]): If set, reads documents as they were at the given time. This must be a timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. If no timezone is specified in the :class:`datetime.datetime` object, it is assumed to be UTC. Returns: `StreamGenerator[List[AggregationResult]]`: A generator of the query results. r&N)r?r)rrr r!rrZinner_generatorrrrr's& zAggregationQuery.stream)rr) r r r!r"rr#rr$rr%)NN) rr:r r r!r;rr#rr$rr<) rr@r r r!r;rr#rr$rrA)__name__ __module__ __qualname____doc__rr r4r5r+r3r9r?r' __classcell__rrrrr-s48   Qr)rE __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_generatorrdatetimeZgoogle.cloud.firestore_v1rZ'google.cloud.firestore_v1.query_profilerrrrrrrs