VSf?dZddlmZddlmZddlmZddlmZddl m Z m Z m Z m Z mZmZddlmZddlmZdd lmZdd lmZmZmZmZmZer dd lmZdd lmZGd de Z Gdde e Z!y)a+Classes for representing queries for the Google Cloud Firestore API. A :class:`~google.cloud.firestore_v1.query.Query` can be created directly from a :class:`~google.cloud.firestore_v1.collection.Collection` and that can be a more common way to create a query than direct usage of the constructor. ) annotations)gapic_v1) retry_async) firestore_v1)BaseCollectionGroup BaseQueryQueryPartition_query_response_to_snapshot,_collection_group_query_response_to_snapshot_enum_from_direction)async_document)AsyncAggregationQuery)DocumentSnapshot)AsyncGeneratorListOptionalType TYPE_CHECKING) Transaction) FieldPathc(eZdZdZ d d fd Z d dZdejjdf ddZ d ddZ d ddZ d ddZ dejjdf dd Z e dd ZxZS) AsyncQueryaG Represents a query to the Firestore API. Instances of this class are considered immutable: all methods that would modify an instance instead return a new instance. Args: parent (:class:`~google.cloud.firestore_v1.collection.CollectionReference`): The collection that this query applies to. projection (Optional[:class:`google.cloud.proto.firestore.v1. query.StructuredQuery.Projection`]): A projection of document fields to limit the query results to. field_filters (Optional[Tuple[:class:`google.cloud.proto.firestore.v1. query.StructuredQuery.FieldFilter`, ...]]): The filters to be applied in the query. orders (Optional[Tuple[:class:`google.cloud.proto.firestore.v1. query.StructuredQuery.Order`, ...]]): The "order by" entries to use in the query. limit (Optional[int]): The maximum number of documents the query is allowed to return. offset (Optional[int]): The number of results to skip. start_at (Optional[Tuple[dict, bool]]): Two-tuple of : * a mapping of fields. Any field that is present in this mapping must also be present in ``orders`` * an ``after`` flag The fields and the flag combine to form a cursor used as a starting point in a query result set. If the ``after`` flag is :data:`True`, the results will start just after any documents which have fields matching the cursor, otherwise any matching documents will be included in the result set. When the query is formed, the document values will be used in the order given by ``orders``. end_at (Optional[Tuple[dict, bool]]): Two-tuple of: * a mapping of fields. Any field that is present in this mapping must also be present in ``orders`` * a ``before`` flag The fields and the flag combine to form a cursor used as an ending point in a query result set. If the ``before`` flag is :data:`True`, the results will end just before any documents which have fields matching the cursor, otherwise any matching documents will be included in the result set. When the query is formed, the document values will be used in the order given by ``orders``. all_descendants (Optional[bool]): When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections. recursive (Optional[bool]): When true, returns all documents and all documents in any subcollections below them. Defaults to false. Nc Btt| ||||||||| | |  yN) parent projection field_filtersorderslimit limit_to_lastoffsetstart_atend_atall_descendants recursive)superr__init__ selfrrrrrr r!r"r#r$r% __class__s dC:\Users\user\Documents\project_loop\venv\Lib\site-packages\google/cloud/firestore_v1/async_query.pyr'zAsyncQuery.__init__js: j$(!''+ ) cNK|j}d}|j}d} |j||}|j|}|r|j |}|j d{}|r|d}|t |z }|t ||ks|r||k\ry75w)Nr)_limit_copy_resolve_chunk_sizer start_aftergetlen) r) chunk_size max_to_return num_returnedoriginal last_document _chunk_size_q snapshotss r+ _chunkifyzAsyncQuery._chunkifys(,{{  #zz|48  (;;L*UK ,B^^M2 ffhI )" C N *LO 9~ +,-"?9'sA+B%-B#.6B%czK|j}|jrW|jD]A}t|j|jk(r |j n |j|_Cd|_|j |||}|2cgc3d{}| 76ncc}w}}|rtt|}|Sw)aRead the documents in the collection that match this query. This sends a ``RunQuery`` RPC and returns a list of documents returned in the stream of ``RunQueryResponse`` messages. Args: transaction (Optional[:class:`~google.cloud.firestore_v1.transaction.Transaction`]): An existing transaction that this query will run in. 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. 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). Returns: list: The documents in the collection that match this query. F) transactionretrytimeoutN) _limit_to_last_ordersr direction ASCENDING DESCENDINGstreamlistreversed)r)r?r@rAis_limited_to_lastorderresultds r+r3zAsyncQuery.gets6"00    "6$..8OO#  #(D E7S#)**a!**** (6*+F s6BB; B BB BBBB B;c8t|j|S)aAdds a count over the nested query. Args: alias(Optional[str]): Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format field_. Returns: :class:`~google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery`: An instance of an AsyncAggregationQuery object alias)rcount)r)rPs r+rQzAsyncQuery.counts%T*00u0==r,c:t|j||S)a.Adds a sum over the nested query. Args: field_ref(Union[str, google.cloud.firestore_v1.field_path.FieldPath]): The field to aggregate across. alias(Optional[str]): Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format field_. Returns: :class:`~google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery`: An instance of an AsyncAggregationQuery object rO)rsumr) field_refrPs r+rSzAsyncQuery.sum%T*..y.FFr,c:t|j||S)a/Adds an avg over the nested query. Args: field_ref(Union[str, google.cloud.firestore_v1.field_path.FieldPath]): The field to aggregate across. alias(Optional[str]): Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format field_. Returns: :class:`~google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery`: An instance of an AsyncAggregationQuery object rO)ravgrTs r+rXzAsyncQuery.avgrVr,cjK|j|||\}}}|jjjd||jjd|d{}|23d{}|j rt ||j} nt||j|} | F| L7R7I6yw)a(Read the documents in the collection that match this query. This sends a ``RunQuery`` RPC and then returns an iterator which consumes each document returned in the stream of ``RunQueryResponse`` messages. .. note:: The underlying stream of responses will time out after the ``max_rpc_timeout_millis`` value set in the GAPIC client configuration for the ``RunQuery`` API. Snapshots not consumed from the iterator before that point will be lost. 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 (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. Yields: :class:`~google.cloud.firestore_v1.async_document.DocumentSnapshot`: The next document that fulfills the query. requestmetadataN) _prep_stream_client_firestore_api run_query _rpc_metadata_all_descendantsr _parentr ) r)r?r@rAr[expected_prefixkwargsresponse_iteratorresponsesnapshots r+rGzAsyncQuery.stream sH,0+<+<   , (& #H$,,"="="G"G# \\//# #   0  ($$Gdll7dllO#! /s<AB3B-B3!B1%B/&B1)=B3'B3/B11B3cddlm}|S)NrAsyncCollectionReference)*google.cloud.firestore_v1.async_collectionrlrks r+_get_collection_reference_classz*AsyncQuery._get_collection_reference_classGs X''r,) Nr]r]NFNNNFFreturnNone)r5intrpz,AsyncGenerator[List[DocumentSnapshot], None])r?rr@retries.AsyncRetryrAfloatrprHN)rP str | NonerpType['firestore_v1.async_collection.AsyncCollectionReference'])__name__ __module__ __qualname____doc__r'r=rmethodDEFAULTr3rQrSrXrG staticmethodrn __classcell__r*s@r+rr/sL8z   8$$ 5$P$($,OO$;$; . .". .  .b#' > > E > ?CG(G1;G EG"?CG(G1;G EG$$,OO$;$; :": : ? :x(F((r,rceZdZdZ d dfd ZedZejjdf ddZ xZ S) AsyncCollectionGroupaRepresents a Collection Group in the Firestore API. This is a specialization of :class:`.AsyncQuery` that includes all documents in the database that are contained in a collection or subcollection of the given parent. Args: parent (:class:`~google.cloud.firestore_v1.collection.CollectionReference`): The collection that this query applies to. Nc Btt| ||||||||| | |  yr)r&rr'r(s r+r'zAsyncCollectionGroup.__init__\s; "D2!''+ 3 r,ctSru)rr]r,r+_get_query_classz%AsyncCollectionGroup._get_query_classxsr,cK|j|||\}}|jjjd||jjd|d{}d}|23d{}|jj |j dj} t||| | }N7V7K6t||dyw)a Partition a query for parallelization. Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used as starting/end points for the query results. Args: partition_count (int): The desired maximum number of partition points. The number must be strictly positive. The actual number of partitions returned may be fewer. 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. rZNrr]) _prep_get_partitionsr_r`partition_queryrbdocumentvaluesreference_valuer ) r)partition_countr@rAr[rfpagerr" cursor_pbcursors r+get_partitionsz#AsyncCollectionGroup.get_partitions|s*33OUGTAdll11AA \\//    $  )\\**9+;+;A+>+N+NOF x8 8H  u T8T22s7ACB0C"B4&B2'B4*AC2B44C) Nr]r]NFNNNTFro)r@rsrArtrpz$AsyncGenerator[QueryPartition, None]) rxryrzr{r'r~rrr|r}rrrs@r+rrPs    8 %-OO$;$; "3""3 "3 . "3r,rN)"r{ __future__rgoogle.api_corerrretries google.cloudr$google.cloud.firestore_v1.base_queryrrr r r r google.cloud.firestore_v1r +google.cloud.firestore_v1.async_aggregationr'google.cloud.firestore_v1.base_documentrtypingrrrrr%google.cloud.firestore_v1.transactionr$google.cloud.firestore_v1.field_pathrrrr]r,r+rs\ #$2%5MDFFA>^(^(B N3:':N3r,