VSfc)dZddlmZddlmZddlmZmZddlm Z ddlm Z ddlm Z ddl mZdd lmZdd lmZmZmZmZmZdd lmZGd d ee j0Zy)zHClasses for representing collections for the Google Cloud Firestore API.)gapic_v1)retry)BaseCollectionReference_item_to_document_ref)query) aggregation) vector_query)Watch)document)AnyCallable GeneratorTupleUnion) Transactionc eZdZdZdfd Zdej fdZdejfdZ de jfdZ dejj dfded eedfd ej*d eedfdeeeff d Zdejj dfd eedfd ej*d eedfdeeedffdZdefdZdejj dfdeedfd ej*d eedfdefdZ dejj dfdeedfd ej*d eedfdee!jDedffdZ#de$de%fdZ&xZ'S)CollectionReferencea 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. returnNc,tt| |i|yN)superr__init__)selfpathkwargs __class__s cC:\Users\user\Documents\project_loop\venv\Lib\site-packages\google/cloud/firestore_v1/collection.pyrzCollectionReference.__init__=s !414B6Bc,tj|S)zeQuery factory. Returns: :class:`~google.cloud.firestore_v1.query.Query` ) query_modQueryrs r_queryzCollectionReference._query@s t$$rcHtj|jS)zAggregationQuery factory. Returns: :class:`~google.cloud.firestore_v1.aggregation_query.AggregationQuery` )rAggregationQueryr#r"s r_aggregation_queryz&CollectionReference._aggregation_queryHs ++DKKM::rcHtj|jS)zxVectorQuery factory. Returns: :class:`~google.cloud.firestore_v1.vector_query.VectorQuery` )r VectorQueryr#r"s r _vector_queryz!CollectionReference._vector_queryPs '' 66r document_data document_idrtimeoutcr|j||||\}}|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)rr*r+rr, document_refr write_results raddzCollectionReference.addXsND $~~       f +|**=CFC ''55r page_sizecj|||\}}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 )requestmetadatac36K|]}t|ywr)r).0irs r z5CollectionReference.list_documents..sA1%dA.As)_prep_list_documents_client_firestore_apilist_documents _rpc_metadata)rr4rr,r6riterators` rr@z"CollectionReference.list_documentssf.33IugN=4<<..== \\//   BAAr chunk_sizec@|jj|Sr)r# _chunkify)rrCs rrEzCollectionReference._chunkifys{{}&&z22r transactioncT|j||\}}|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`]): 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 this collection that match the query. rFr<)_prep_get_or_streamgetrrFrr,rrs rrIzCollectionReference.gets3600@ vuyy;[;F;;rcT|j||\}}|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`]): An existing transaction that the 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.document.DocumentSnapshot`: The next document that fulfills the query. rFr<)rHstreamrJs rrLzCollectionReference.streams4H00@ vu||> >v>>rcallbackcl|j}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_queryr DocumentSnapshot)rrMrs r on_snapshotzCollectionReference.on_snapshots(4 uh0I0IJJr)rN)(__name__ __module__ __qualname____doc__rr r!r#rr%r&r r(r)rmethodDEFAULTdictrstrretriesRetryfloatrr r3intrr@rErlistrIr rPrLr r rQ __classcell__)rs@rrr#s2C% %;K$@$@;7|777)-'66&* )6)639%)6}} )6 ud{# )6 sCx )6Z'+'66&* Bd#B}}Bud{# B 3T> " B@3C3 15'66&* <;,-<}}<ud{# <  rfsLO$,9121.99>eK1)//BeKr