U $FZh9^@s0dZddlmZddlmZmZmZmZmZm Z m Z m Z m Z ddl mZmZddl mZddlmZddlmZmZddlmZdd lmZdd lmZmZmZmZm Z m!Z!dd l"m#Z#dd l$m%Z%dd l&m'Z'ddl(m)Z)er ddl*m+Z+ddl,m-Z-ddl.m/Z/m0Z0GdddeZ1Gddde1eZ2dS)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) TYPE_CHECKINGAnyCallable GeneratorListOptionalSequenceTypeUnion) exceptionsgapic_v1)retry) firestore_v1) aggregation transaction)QueryResultsList)DocumentSnapshot)BaseCollectionGroup BaseQueryQueryPartition,_collection_group_query_response_to_snapshot_enum_from_direction_query_response_to_snapshot)StreamGenerator)Vector) VectorQuery)Watch)DistanceMeasure) FieldPath)ExplainMetricsExplainOptionsc s:eZdZdZd@ddfdd Zdejjdfdd d d d d dddZdddddZ dAddZ ddZ ddddddddd dd d!d"Z dBd#d$d%d&d'Z dCd(d#d$d)d*d+ZdDd(d#d$d)d,d-Zdejjddfd.d d/d d0d1d2d3Zdejjdfdd d4d d/d d5d1d6d7Zd8d9d:d;d<Zed=dd>d?ZZS)EQuerya 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.firestore_v1. query.StructuredQuery.Projection`]): A projection of document fields to limit the query results to. field_filters (Optional[Tuple[:class:`google.cloud.firestore_v1. query.StructuredQuery.FieldFilter`, ...]]): The filters to be applied in the query. orders (Optional[Tuple[:class:`google.cloud.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. NFNonereturnc s*tt|j||||||||| | | d dSN) parent projection field_filtersorderslimit limit_to_lastoffsetstart_atend_atall_descendants recursive)superr"__init__ selfr(r)r*r+r,r-r.r/r0r1r2 __class__r#f/home/aprabhat/apps/x.techxrdev.in/venv/lib/python3.8/site-packages/google/cloud/firestore_v1/query.pyr4ws zQuery.__init__)explain_optionsretries.Retry | object | NonezOptional[float]zOptional[ExplainOptions]z"QueryResultsList[DocumentSnapshot])rtimeoutr:r&c Csd}|j}|jrB|jD]$}t|jj|jkr0|jn|j|_qd|_|j||||d}t|} |rltt | } |dkrzd}n| }t | ||S)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. 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[DocumentSnapshot]: The documents in the collection that match this query. NFrrr<r:) Z_limit_to_lastZ_ordersr directionnameZ ASCENDINGZ DESCENDINGstreamlistreversedZget_explain_metricsr) r6rrr<r:explain_metricsZis_limited_to_lastorderresultZ result_listr#r#r9gets.!   z Query.getintz-Generator[List[DocumentSnapshot], None, None]) chunk_sizer&c cs|j}d}|}d}|||}||}|r:||}|}|rN|d}|t|7}|Vt||ksx|r||krdSqdS)Nr)Z_limitZ_copyZ_resolve_chunk_sizer, start_afterrFlen) r6rHZ max_to_returnZ num_returnedoriginalZ last_document _chunk_sizeZ_qZ snapshotsr#r#r9 _chunkifys&     zQuery._chunkifyc Cs<|||||\}}}|jjjf||jjd|}||fS)!Helper method for :meth:`stream`.requestmetadata)Z _prep_stream_client_firestore_api run_query _rpc_metadata) r6rrr<r:rQexpected_prefixkwargsresponse_iteratorr#r#r9_get_stream_iterators  zQuery._get_stream_iteratorcCs8|dkr4|tjjkr*|jjj}|j}|j}||SdS)rONF) r methodDEFAULTrSrTZ _transportrUZ_retryZ _predicate)r6excrr transportZgapic_callabler#r#r9_retry_query_after_exception s   z"Query._retry_query_after_exception)distance_result_fielddistance_thresholdstrzUnion[Vector, Sequence[float]]rz Optional[str]z-Type['firestore_v1.vector_query.VectorQuery']) vector_field query_vectorr,distance_measurer`rar&cCst|j||||||dS)a9 Finds the closest vector embeddings to the given query vector. Args: vector_field (str): An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned. query_vector(Vector | Sequence[float]): The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. limit (int): The number of nearest neighbors to return. Must be a positive integer of no more than 1000. distance_measure (:class:`DistanceMeasure`): The Distance Measure to use. distance_result_field (Optional[str]): Name of the field to output the result of the vector distance calculation. If unset then the distance will not be returned. distance_threshold (Optional[float]): A threshold for which no less similar documents will be returned. Returns: :class`~firestore_v1.vector_query.VectorQuery`: the vector query. )rcrdr,rer`ra)r find_nearest)r6rcrdr,rer`rar#r#r9rfszQuery.find_nearestz str | Nonez1Type['firestore_v1.aggregation.AggregationQuery'])aliasr&cCst|j|dS)a Adds a count over the query. :type alias: Optional[str] :param alias: 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_. rg)rAggregationQuerycount)r6rgr#r#r9rj>s z Query.countzstr | FieldPath) field_refrgr&cCst|j||dS)a Adds a sum over the query. :type field_ref: Union[str, google.cloud.firestore_v1.field_path.FieldPath] :param field_ref: The field to aggregate across. :type alias: Optional[str] :param alias: 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_. rh)rrisumr6rkrgr#r#r9rlJs z Query.sumcCst|j||dS)a Adds an avg over the query. :type field_ref: [Union[str, google.cloud.firestore_v1.field_path.FieldPath] :param field_ref: The field to aggregate across. :type alias: Optional[str] :param alias: 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_. rh)rriavgrmr#r#r9rnYs z Query.avgz!Optional[transaction.Transaction] float | Nonez:Generator[DocumentSnapshot, Any, Optional[ExplainMetrics]])rrr<r:r&c csd}|||||\}}d}zt|d} WnZtjk r} z:|| ||rr||} | |||\}} WY qnW5d} ~ XYnX| dkrq|dkr| jr| j}|jrt| |j } nt | |j |} | dk r| }| Vq|S)a(Internal method for stream(). Read the documents in the collection that match this query. Internal method for stream(). This sends a ``RunQuery`` RPC and then returns a generator 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 the 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: DocumentSnapshot: The next document that fulfills the query. Returns: ([google.cloud.firestore_v1.types.query_profile.ExplainMetrtics | None]): The results of query profiling, if received from the service. N) rZnextr ZGoogleAPICallErrorr_rJrCZ_all_descendantsrZ_parentr)r6rrr<r:ZmetricsrYrWZ last_snapshotresponser]Z new_query_Zsnapshotr#r#r9 _make_streamhsL0  zQuery._make_streamztransaction.Transaction | Nonez!StreamGenerator[DocumentSnapshot]cCs|j||||d}t||S)a*Read the documents in the collection that match this query. This sends a ``RunQuery`` RPC and then returns a generator 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 (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[DocumentSnapshot]`: A generator of the query results. r=)rsr)r6rrr<r:Zinner_generatorr#r#r9r@s*z Query.streamrr)callbackr&cCst||tS)aMonitor the documents in this collection that match this query. This starts a watch on this query using a background thread. The provided callback is run on the snapshot of the documents. Args: callback(Callable[[:class:`~google.cloud.firestore.query.QuerySnapshot`], NoneType]): a callback to run when a change occurs. Example: .. code-block:: python from google.cloud import firestore_v1 db = firestore_v1.Client() query_ref = db.collection(u'users').where("user", "==", u'Ada') def on_snapshot(docs, changes, read_time): for doc in docs: print(u'{} => {}'.format(doc.id, doc.to_dict())) # Watch this query query_watch = query_ref.on_snapshot(on_snapshot) # Terminate this watch query_watch.unsubscribe() )rZ for_queryr)r6rtr#r#r9 on_snapshotszQuery.on_snapshotz3Type['firestore_v1.collection.CollectionReference']cCsddlm}|S)NrCollectionReference)Z$google.cloud.firestore_v1.collectionrwrvr#r#r9_get_collection_reference_classs z%Query._get_collection_reference_class) Nr#r#NFNNNFF)N)N)N)N)__name__ __module__ __qualname____doc__r4r r[r\rFrNrZr_rfrjrlrnrsr@ru staticmethodrx __classcell__r#r#r7r9r"?sX:B& ( `2r"c sPeZdZdZdddfdd Zed d Zejj dfd d ddddZ Z S)CollectionGroupa}Represents a Collection Group in the Firestore API. This is a specialization of :class:`.Query` 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. Nr#FTr$r%c s*tt|j||||||||| | | d dSr')r3rr4r5r7r#r9r4,s zCollectionGroup.__init__cCstS)N)r"r#r#r#r9_get_query_classHsz CollectionGroup._get_query_classr;roz%Generator[QueryPartition, None, None])rr<r&c csv||||\}}|jjjf||jjd|}d}|D]*}|j|jdj} t||| V| }q8t||dVdS)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. rPNr) Z_prep_get_partitionsrSrTZpartition_queryrVZdocumentvaluesZreference_valuer) r6Zpartition_countrr<rQrXpagerr/Z cursor_pbcursorr#r#r9get_partitionsLs zCollectionGroup.get_partitions) Nr#r#NFNNNTF) ryrzr{r|r4r}rr r[r\rr~r#r#r7r9r s" rN)3r| __future__rtypingrrrrrrr r r Zgoogle.api_corer r rretriesZ google.cloudrZgoogle.cloud.firestore_v1rrZ'google.cloud.firestore_v1.query_resultsrZ'google.cloud.firestore_v1.base_documentrZ$google.cloud.firestore_v1.base_queryrrrrrrZ*google.cloud.firestore_v1.stream_generatorrZ google.cloud.firestore_v1.vectorrZ&google.cloud.firestore_v1.vector_queryrZgoogle.cloud.firestore_v1.watchrZ+google.cloud.firestore_v1.base_vector_queryrZ$google.cloud.firestore_v1.field_pathrZ'google.cloud.firestore_v1.query_profiler r!r"rr#r#r#r9s, ,            d