. 0hj.dZddlmZddlmZmZmZmZmZm Z m Z ddl m Z ddl m ZddlmZmZddlmZddlmZmZdd lmZmZdd lmZdd lmZerdd lmZdd lm Z ddl!m"Z"Gddeej#Z$dS)zHClasses for representing collections for the Google Cloud Firestore API.) annotations) TYPE_CHECKINGAnyCallable GeneratorOptionalTupleUnion)gapic_v1)retry) aggregationdocument)query) transaction vector_query)BaseCollectionReference_item_to_document_ref)QueryResultsList)Watch)DocumentSnapshot)ExplainOptions)StreamGeneratorceZdZdZd,fd Zd-dZd.dZd/d Zd ej j d fd0dZ d ej j d fd1dZ d2dZ d ej j d fd dd3d#Zd ej j d fd dd4d'Zd5d+ZxZS)6CollectionReferencea A reference to a collection in a Firestore database. The collection may already exist or this class can facilitate creation of documents within the collection. Args: path (Tuple[str, ...]): The components in the collection path. This is a series of strings representing each collection and sub-collection ID, as well as the document IDs for any documents that contain a sub-collection. kwargs (dict): The keyword arguments for the constructor. The only supported keyword is ``client`` and it must be a :class:`~google.cloud.firestore_v1.client.Client` if provided. It represents the client that created this collection reference. Raises: ValueError: if * the ``path`` is empty * there are an even number of elements * a collection ID in ``path`` is not a string * a document ID in ``path`` is not a string TypeError: If a keyword other than ``client`` is used. returnNonecHtt|j|i|dSN)superr__init__)selfpathkwargs __class__s _/var/www/html/nourish/venv/lib/python3.11/site-packages/google/cloud/firestore_v1/collection.pyr zCollectionReference.__init__As,1!4((14B6BBBBBquery_mod.Queryc*tj|S)zeQuery factory. Returns: :class:`~google.cloud.firestore_v1.query.Query` ) query_modQueryr!s r%_queryzCollectionReference._queryDs t$$$r&aggregation.AggregationQuerycNtj|S)zAggregationQuery factory. Returns: :class:`~google.cloud.firestore_v1.aggregation_query.AggregationQuery` )r AggregationQueryr,r+s r%_aggregation_queryz&CollectionReference._aggregation_queryLs +DKKMM:::r&vector_query.VectorQuerycNtj|S)zxVectorQuery factory. Returns: :class:`~google.cloud.firestore_v1.vector_query.VectorQuery` )r VectorQueryr,r+s r% _vector_queryz!CollectionReference._vector_queryTs ' 666r&N document_datadict document_idUnion[str, None]r retries.Retry | object | NonetimeoutUnion[float, None]Tuple[Any, Any]cf|||||\}}|j|fi|}|j|fS)aCreate a document in the Firestore database with the provided data. Args: document_data (dict): Property names and values to use for creating the document. document_id (Optional[str]): The document identifier within the current collection. If not provided, an ID will be automatically assigned by the server (the assigned ID will be a random 20 character string composed of digits, uppercase and lowercase letters). 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. Returns: Tuple[:class:`google.protobuf.timestamp_pb2.Timestamp`, :class:`~google.cloud.firestore_v1.document.DocumentReference`]: Pair of * The ``update_time`` when the document was created/overwritten. * A document reference for the created document. Raises: :class:`google.cloud.exceptions.Conflict`: If ``document_id`` is provided and the document already exists. ) _prep_addcreate update_time)r!r5r7r r: document_refr# write_results r%addzCollectionReference.add\sSD $~~        f +|*=CCFCC '55r& page_sizeUnion[int, None]Generator[Any, Any, None]c|||\}}jjjd|jjd|}fd|DS)a`List all subdocuments of the current collection. Args: page_size (Optional[int]]): The maximum number of documents in each page of results from this request. Non-positive values are ignored. Defaults to a sensible value set by the API. 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. Returns: Sequence[:class:`~google.cloud.firestore_v1.collection.DocumentReference`]: iterator of subdocuments of the current collection. If the collection does not exist at the time of `snapshot`, the iterator will be empty )requestmetadatac38K|]}t|VdSr)r).0ir!s r% z5CollectionReference.list_documents..s.AA1%dA..AAAAAAr&)_prep_list_documents_client_firestore_apilist_documents _rpc_metadata)r!rDr r:rHr#iterators` r%rRz"CollectionReference.list_documentssu.33IugNN=4<.= \/     BAAAAAAAr& chunk_sizeintcP||Sr)r, _chunkify)r!rUs r%rXzCollectionReference._chunkifys{{}}&&z222r&)explain_optionsr$Union[transaction.Transaction, None]rYOptional[ExplainOptions]"QueryResultsList[DocumentSnapshot]c`|||\}}|||d<|jdd|i|S)aRead the documents in this collection. 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.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. 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. 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: QueryResultsList[DocumentSnapshot]: The documents in this collection that match the query. NrYrrN)_prep_get_or_streamgetr!rr r:rYrr#s r%r_zCollectionReference.getsLD00@@ v  &(7F$ %uy;;[;F;;;r&!Optional[transaction.Transaction]Optional[float]!StreamGenerator[DocumentSnapshot]c`|||\}}|r||d<|jdd|i|S)a Read the documents in this collection. 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.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. Returns: `StreamGenerator[DocumentSnapshot]`: A generator of the query results. rYrrN)r^streamr`s r%rezCollectionReference.streamsNT00@@ v  8(7F$ %u|>> >v>>>r&callbackrrcj|}tj||tjS)aMonitor the documents in this collection. This starts a watch on this collection using a background thread. The provided callback is run on the snapshot of the documents. Args: callback (Callable[[:class:`~google.cloud.firestore.collection.CollectionSnapshot`], NoneType]): a callback to run when a change occurs. Example: from google.cloud import firestore_v1 db = firestore_v1.Client() collection_ref = db.collection(u'users') def on_snapshot(collection_snapshot, changes, read_time): for doc in collection_snapshot.documents: print(u'{} => {}'.format(doc.id, doc.to_dict())) # Watch this collection collection_watch = collection_ref.on_snapshot(on_snapshot) # Terminate this watch collection_watch.unsubscribe() )r,r for_queryrr)r!rfrs r% on_snapshotzCollectionReference.on_snapshots(4 uh0IJJJr&)rr)rr')rr-)rr1) r5r6r7r8r r9r:r;rr<)rDrEr r9r:r;rrF)rUrV) rrZr r9r:r;rYr[rr\) rrar r9r:rbrYr[rrc)rfrrr)__name__ __module__ __qualname____doc__r r,r0r4r methodDEFAULTrCrRrXr_reri __classcell__)r$s@r%rr's2CCCCCC%%%%;;;;7777)-/7/F&* )6)6)6)6)6Z'+/7/F&* BBBBB@3333 =A/7/F&* &< 59 &<&<&<&<&<&/7/F#' .? 59 .?.?.?.?.?.?`KKKKKKKKr&rN)%rm __future__rtypingrrrrrr r google.api_corer r retriesgoogle.cloud.firestore_v1r rrr)rr)google.cloud.firestore_v1.base_collectionrr'google.cloud.firestore_v1.query_resultsrgoogle.cloud.firestore_v1.watchr'google.cloud.firestore_v1.base_documentr'google.cloud.firestore_v1.query_profiler*google.cloud.firestore_v1.stream_generatorrr*rrNr&r%r|sON""""""RRRRRRRRRRRRRRRRRR$$$$$$,,,,,,;;;;;;;;888888????????EDDDDD111111KHHHHHHFFFFFFJJJJJJvKvKvKvKvK1)/BvKvKvKvKvKr&