o  i%@sdZddlmZddlmZmZmZmZmZm Z ddl m Z m Z ddl m ZddlmZmZmZddlmZddlmZerPdd 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)ExplainOptionscseZdZdZdfdd Zdejjdfddd ddZd!ddZ ddZ dejjddfd"ddZ dejjdfddd#ddZ Z S)$AggregationQueryz5Represents 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/aggregation.pyr.szAggregationQuery.__init__N)explain_optionsr "Union[retries.Retry, None, object]timeout float | Noner Optional[ExplainOptions]#QueryResultsList[AggregationResult]cCs@d}|j||||d}t|}|durd}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 r"r )streamlistget_explain_metricsr)rrr r"r explain_metricsresult result_listrrrget4s" zAggregationQuery.getcCs2|||||\}}|jjjd||jjd|S)!Helper method for :meth:`stream`.)requestmetadataNr) _prep_stream_client_firestore_apirun_aggregation_query _rpc_metadata)rrr r"r r/kwargsrrr_get_stream_iteratorgs z%AggregationQuery._get_stream_iteratorcCs8|dur|tjjur|jjj}|j}|j}||SdS)r.NF) r methodDEFAULTr2r3 _transportr4_retry _predicate)rexcr r transportgapic_callablerrr_retry_query_after_exceptionvs   z-AggregationQuery._retry_query_after_exceptionr!Optional[transaction.Transaction]Optional[float]AGenerator[List[AggregationResult], Any, Optional[ExplainMetrics]]c csd}|||||} zt|d}Wn"tjy5}z||||r0||||}WYd}~q d}~ww|dur= |S|durG|jrG|j}t|} | rP| Vq )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)r7nextr GoogleAPICallErrorr@r*r) rrr r"r metricsresponse_iteratorresponser=r+rrr _make_streams>'   zAggregationQuery._make_stream#Optional['transaction.Transaction'](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&)rIr)rrr r"r inner_generatorrrrr's# zAggregationQuery.stream)rr)r r!r"r#r r$rr%r) rrAr r!r"rBr r$rrC) rrJr r!r"rBr r$rrK)__name__ __module__ __qualname____doc__rr r8r9r-r7r@rIr' __classcell__rrrrr+s, 3  KrN)rP __future__rtypingrrrrrrgoogle.api_corer r r retries*google.cloud.firestore_v1.base_aggregationr r r'google.cloud.firestore_v1.query_resultsr*google.cloud.firestore_v1.stream_generatorrgoogle.cloud.firestore_v1r'google.cloud.firestore_v1.query_profilerrrrrrrs