Ѯh%dZddlmZddlmZmZmZmZmZm Z ddl m Z m Z ddl m ZddlmZmZmZddlmZddlmZerdd lmZdd lmZdd lmZGd d eZy)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)ExplainOptionsceZdZdZ d fd Zdej jdfdd d dZd dZ dZ dej jddf d dZ dej jdfdd dd Z xZ S)AggregationQueryz5Represents an aggregation query to the Firestore API.c,tt| |yN)superr__init__)self nested_query __class__s w/home/www/academy-backend.kofcorporation.com/venv/lib/python3.12/site-packages/google/cloud/firestore_v1/aggregation.pyrzAggregationQuery.__init__.s .|<N)explain_optionscd}|j||||}t|}|d}n|j}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 timeoutr )streamlistget_explain_metricsr)rrr r#r explain_metricsresult result_lists rgetzAggregationQuery.get4s\D26#+   6l  ""O$88:O _oNNrc|j||||\}}|jjjd||jjd|S)!Helper method for :meth:`stream`.)requestmetadata) _prep_stream_client_firestore_apirun_aggregation_query _rpc_metadata)rrr r#r r-kwargss r_get_stream_iteratorz%AggregationQuery._get_stream_iteratorgsc++      At||**@@ \\//   rc|e|tjjur8|jjj }|j }|j}|j|Sy)r,F) r methodDEFAULTr1r2 _transportr3_retry _predicate)rexcr r transportgapic_callables r_retry_query_after_exceptionz-AggregationQuery._retry_query_after_exceptionvsY  /// LL77BB !*!@!@&--##C( (rc#BKd}|j||||} t|d}| |S||j r |j }t |} | r| >#tj$r1}|j |||r|j|||}Yd}~}d}~wwxYww)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)r6nextr GoogleAPICallErrorr@r'r) rrr r#r metricsresponse_iteratorresponser=r(s r _make_streamzAggregationQuery._make_streamsN*. 55         1488#;#;"22.x8F -00 44S%M(,(A(A#)%  s3B A1BB+&BBBBBcD|j||||}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")rGr)rrr r#r inner_generators rr$zAggregationQuery.streams5F++#+ ,  @@r)returnNone)r "Union[retries.Retry, None, object]r#z float | Noner Optional[ExplainOptions]rJz#QueryResultsList[AggregationResult]r) rz!Optional[transaction.Transaction]r rLr#Optional[float]r rMrJzAGenerator[List[AggregationResult], Any, Optional[ExplainMetrics]]) rz#Optional['transaction.Transaction']r rLr#rNr rMrJz(StreamGenerator[List[AggregationResult]])__name__ __module__ __qualname____doc__rr r8r9r*r6r@rGr$ __classcell__)rs@rrr+s#?= =44r]sM #GG0, EF5FFHA+HAr