U >i,@s6dZddlmZddlZddlmZddlmZmZmZm Z m Z m Z m Z ddl mZddl mZddlmZdd lmZdd lmZerdd lmZdd lmZdd lmZddlmZddlmZGddde Z!GdddeZ"Gddde"Z#Gddde"Z$Gddde"Z%ddddZ&GdddeZ'dS) 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@s*eZdZdZd dddddZdd ZdS) 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 Nstrfloat)aliasvaluecCs||_||_||_dSNrr read_time)selfrrrrN/tmp/pip-unpacked-wheel-599y42ri/google/cloud/firestore_v1/base_aggregation.py__init__:szAggregationResult.__init__cCsd|jd|jd|jdS)Nzrrrrr__repr__?szAggregationResult.__repr__)N)__name__ __module__ __qualname____doc__r r#rrrrr/s rc@s*eZdZdddddZejddZdS) BaseAggregationN str | NonercCs ||_dSrr*rrrrrr DszBaseAggregation.__init__cCsdS)4Convert this instance to the protobuf representationNrr"rrr _to_protobufGszBaseAggregation._to_protobuf)N)r$r%r&r abcabstractmethodr-rrrrr(Csr(cs,eZdZdddfdd ZddZZS) CountAggregationNr)r*cstt|j|ddSNr*)superr0r r+ __class__rrr MszCountAggregation.__init__cCs t}|j|_tj|_|Sr,)r AggregationrZCountcountraggregation_pbrrrr-Ps zCountAggregation._to_protobuf)Nr$r%r&r r- __classcell__rrr3rr0Lsr0cs.eZdZd dddfdd ZddZZS) SumAggregationNstr | FieldPathr) field_refrcs.t|tr|}||_tt|j|ddSr1) isinstancer to_api_reprr?r2r<r rr?rr3rrr Ys zSumAggregation.__init__cCs,t}|j|_tj|_|j|jj_|Sr5)rr6rZSumsumr?field field_pathr8rrrr-`s   zSumAggregation._to_protobuf)Nr:rrr3rr<Xsr<cs.eZdZd dddfdd ZddZZS) AvgAggregationNr=r)r>cs.t|tr|}||_tt|j|ddSr1)r@rrAr?r2rFr rBr3rrr js zAvgAggregation.__init__cCs,t}|j|_tj|_|j|jj_|Sr5)rr6rZAvgavgr?rDrEr8rrrr-qs   zAvgAggregation._to_protobuf)Nr:rrr3rrFisrFzList[AggregationResult]returncs fddjjjD}|S)Ncs4g|],}t|jj|jp&jj|jjdqS)r)rresultaggregate_fieldsZ integer_valueZ double_valuer).0key response_pbrr }s z-_query_response_to_result..)rJrKpbkeys)rOresultsrrNr_query_response_to_resultzs   rTc @seZdZdZd1dddddZedd Zd2dd d d Zd3d ddddZd4d ddddZ dddddZ dddddZ ddddZ d5dd d!d"d#d$d%Z ejdejjdfdd&dd d!d'd#d(d)Zejdejjdfdd&d*d+d,d!d-d.d/d0ZdS)6BaseAggregationQueryz5Represents an aggregation query to the Firestore API.Nr)None)rrIcCs||_||_|j|_g|_dSr) _nested_query_alias_parent_collection_ref _aggregations)rZ nested_queryrrrrr szBaseAggregationQuery.__init__cCs|jjSr)rZ_clientr"rrrr\szBaseAggregationQuery._clientr*cCst|d}|j||S)z4 Adds a count over the nested query r*)r0r[append)rrZcount_aggregationrrrr7s  zBaseAggregationQuery.countr=r>cCst||d}|j||S)z2 Adds a sum over the nested query r*)r<r[r])rr?rZsum_aggregationrrrrCs  zBaseAggregationQuery.sumcCst||d}|j||S)z3 Adds an avg over the nested query r*)rFr[r])rr?rZavg_aggregationrrrrGs  zBaseAggregationQuery.avgr() aggregationrIcCs|j|dS)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)r[r])rr^rrradd_aggregationsz$BaseAggregationQuery.add_aggregationzList[BaseAggregation]) aggregationsrIcCs|j|dS)z Adds a list of aggregations to the nested query :type aggregations: list :param aggregations: a list of aggregation operations N)r[extend)rr`rrradd_aggregationssz%BaseAggregationQuery.add_aggregationsrrHcCs6t}|j|_|jD]}|}|j|q|Sr)rrWr-Zstructured_queryr[r`r])rrQr^r9rrrr-s   z!BaseAggregationQuery._to_protobufz6Union[retries.Retry, retries.AsyncRetry, None, object]z float | NonezOptional[ExplainOptions]zTuple[dict, dict])r timeoutexplain_optionsrIc CsH|j\}}||t|d}|r4||d<t||}||fS)N)parentZstructured_aggregation_queryrrd)rZZ _parent_infor-r Zget_transaction_idZ_to_dictZmake_retry_timeout_kwargs) rrr rcrd parent_pathZexpected_prefixrequestkwargsrrr _prep_streams  z!BaseAggregationQuery._prep_stream)rdzXQueryResultsList[AggregationResult] | Coroutine[Any, Any, List[List[AggregationResult]]]cCsdS)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. Nrrrr rcrdrrrgetszBaseAggregationQuery.getz!Optional[transaction.Transaction]z2retries.Retry | retries.AsyncRetry | object | NonezOptional[float]zXStreamGenerator[List[AggregationResult]] | AsyncStreamGenerator[List[AggregationResult]])rr rcrdrIcCsdS)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. NrrjrrrstreamszBaseAggregationQuery.stream)N)N)N)N)NNNN)r$r%r&r'r propertyr\r7rCrGr_rbr-rir.r/r methodDEFAULTrkrlrrrrrUs:    ( rU)(r' __future__rr.rtypingrrrrrr r Zgoogle.api_corer r retriesZgoogle.cloud.firestore_v1r Z$google.cloud.firestore_v1.field_pathrZgoogle.cloud.firestore_v1.typesrrZ0google.cloud.firestore_v1.async_stream_generatorrZ'google.cloud.firestore_v1.query_profilerZ'google.cloud.firestore_v1.query_resultsrZ*google.cloud.firestore_v1.stream_generatorrobjectrr(r0r<rFrTrUrrrrs,  $