Ѯh,XdZddlmZddlZddlmZddlmZmZmZm Z m Z m Z m Z ddl mZddl mZddlmZdd lmZdd lmZerdd lmZdd lmZdd lmZddlmZddlmZGdde Z!GddeZ"Gdde"Z#Gdde"Z$Gdde"Z% ddZ&GddeZ'y)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. ) annotationsN)ABC) TYPE_CHECKINGAny CoroutineListOptionalTupleUnion)gapic_v1)retry)_helpers) FieldPath)StructuredAggregationQuery) transaction)AsyncStreamGenerator)ExplainOptions)QueryResultsList)StreamGeneratorc eZdZdZdddZdZy)AggregationResulta A class representing result from Aggregation Query :type alias: str :param alias: The alias for the aggregation. :type value: int :param value: The resulting value from the aggregation. :type read_time: :param value: The resulting read_time Nc.||_||_||_yNaliasvalue read_time)selfrrrs |/home/www/academy-backend.kofcorporation.com/venv/lib/python3.12/site-packages/google/cloud/firestore_v1/base_aggregation.py__init__zAggregationResult.__init__:s  "cVd|jd|jd|jdS)Nzrrs r__repr__zAggregationResult.__repr__?s.$TZZL KPTP^P^O__`aar!r)rstrrfloat)__name__ __module__ __qualname____doc__r r%r!rrr/s# br!rc:eZdZdddZej dZy)BaseAggregationNc||_yrr)rrs rr zBaseAggregation.__init__Ds  r!cy)4Convert this instance to the protobuf representationNr,r$s r _to_protobufzBaseAggregation._to_protobufGr!rr str | None)r(r)r*r abcabstractmethodr3r,r!rr.r.Cs# CCr!r.c(eZdZddfd ZdZxZS)CountAggregationc.tt| |yNr0)superr:r )rr __class__s rr zCountAggregation.__init__Ms .U.;r!ctj}|j|_tjj|_|Sr2)r AggregationrCountcountraggregation_pbs rr3zCountAggregation._to_protobufPs93??A#zz9EEKKMr!rr5r(r)r*r r3 __classcell__r>s@rr:r:Ls <r!r:c(eZdZddfd ZdZxZS)SumAggregationc|t|tr|j}||_tt ||yr<) isinstancer to_api_repr field_refr=rJr rrNrr>s rr zSumAggregation.__init__Y4 i +!--/I" nd,5,9r!ctj}|j|_tjj|_|j |jj _|Sr@)rrArSumsumrNfield field_pathrDs rr3zSumAggregation._to_protobuf`Q3??A#zz7CCGGI.2nn  +r!rrNzstr | FieldPathrr6rFrHs@rrJrJX :r!rJc(eZdZddfd ZdZxZS)AvgAggregationc|t|tr|j}||_tt ||yr<)rLrrMrNr=rZr rOs rr zAvgAggregation.__init__jrPr!ctj}|j|_tjj|_|j |jj _|Sr@)rrArAvgavgrNrTrUrDs rr3zAvgAggregation._to_protobufqrVr!rrWrFrHs@rrZrZirXr!rZc>|jjjjDcgc]`}t ||jj|j xs#|jj|j |jb}}|Scc}w)Nr)resultaggregate_fieldspbkeysr integer_value double_valuer) response_pbkeyresultss r_query_response_to_resultrizs%%6699>>@  $$55c:HHE!!2237DD!++  G NsA%BcXeZdZdZdddZedZdddZdddZdddZ ddZ dd Z dd Z d dd Z ejdej"j$dfdd  dd Zejdej"j$dfdd  ddZy)BaseAggregationQueryz5Represents an aggregation query to the Firestore API.NcP||_||_|j|_g|_yr) _nested_query_alias_parent_collection_ref _aggregations)r nested_queryrs rr zBaseAggregationQuery.__init__s') +3346r!c.|jjSr)rp_clientr$s rrtzBaseAggregationQuery._clients##+++r!cTt|}|jj||S)z4 Adds a count over the nested query r0)r:rqappend)rrcount_aggregations rrCzBaseAggregationQuery.counts)-59 !!"34 r!cVt||}|jj||S)z2 Adds a sum over the nested query r0)rJrqrv)rrNrsum_aggregations rrSzBaseAggregationQuery.sum))%@ !!/2 r!cVt||}|jj||S)z3 Adds an avg over the nested query r0)rZrqrv)rrNravg_aggregations rr^zBaseAggregationQuery.avgrzr!c:|jj|y)z Adds an aggregation operation to the nested query :type aggregation: :class:`google.cloud.firestore_v1.aggregation.BaseAggregation` :param aggregation: An aggregation operation, e.g. a CountAggregation N)rqrv)r aggregations radd_aggregationz$BaseAggregationQuery.add_aggregations !!+.r!c:|jj|y)z Adds a list of aggregations to the nested query :type aggregations: list :param aggregations: a list of aggregation operations N)rqextend)r aggregationss radd_aggregationsz%BaseAggregationQuery.add_aggregationss !!,/r!ct}|jj|_|jD]-}|j}|j j |/|Sr)rrmr3structured_queryrqrrv)rrbr~rEs rr3z!BaseAggregationQuery._to_protobufs] ' )"00==?-- 3K(557N OO " "> 2 3 r!c|jj\}}||jtj|d}|r|j |d<tj ||}||fS)N)parentstructured_aggregation_queryrexplain_options)rp _parent_infor3rget_transaction_id_to_dictmake_retry_timeout_kwargs) rrr timeoutr parent_pathexpected_prefixrequestkwargss r _prep_streamz!BaseAggregationQuery._prep_streamsv(,';';'H'H'J$ _!,0,=,=,?#66{C  )8)A)A)CG% &33E7Cr!)rcy)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]] | Coroutine[Any, Any, List[List[AggregationResult]]]): The aggregation query results. Nr,rrr rrs rgetzBaseAggregationQuery.getr4r!cy)a[Runs the aggregation query. This sends a``RunAggregationQuery`` RPC and returns a generator 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. 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]] | AsyncStreamGenerator[List[AggregationResult]]: A generator of the query results. Nr,rs rstreamzBaseAggregationQuery.streamr4r!r)rr6returnNoner5rW)r~r.rr)rzList[BaseAggregation]rr)rr)NNNN)r 6Union[retries.Retry, retries.AsyncRetry, None, object]r float | NonerOptional[ExplainOptions]rzTuple[dict, dict])r rrrrrrzXQueryResultsList[AggregationResult] | Coroutine[Any, Any, List[List[AggregationResult]]]) rz!Optional[transaction.Transaction]r z2retries.Retry | retries.AsyncRetry | object | NonerzOptional[float]rrrzXStreamGenerator[List[AggregationResult]] | AsyncStreamGenerator[List[AggregationResult]])r(r)r*r+r propertyrtrCrSr^rrr3rr7r8r methodDEFAULTrrr,r!rrkrksG?7 ,,/0HL $48 F  2   &  OO # # $ & 59&  &  & 2&  =& & P :>((#'# 59# 6# # !# 2#  8# # r!rk)rzList[AggregationResult])(r+ __future__rr7rtypingrrrrr r r google.api_corer r retriesgoogle.cloud.firestore_v1r$google.cloud.firestore_v1.field_pathrgoogle.cloud.firestore_v1.typesrr0google.cloud.firestore_v1.async_stream_generatorr'google.cloud.firestore_v1.query_profiler'google.cloud.firestore_v1.query_resultsr*google.cloud.firestore_v1.stream_generatorrobjectrr.r:rJrZrirkr,r!rrs # NNN$,.: 5UFH bb(CcC  _"_"   ` 3` r!