a !f'(@sdZddlmZddlmZddlmZmZddlm Z ddlm Z ddl m Z ddlmZdd lmZmZmZmZmZdd lmZGd d d eZd S)zHClasses for representing collections for the Google Cloud Firestore API.)gapic_v1)retry)BaseCollectionReference_item_to_document_ref)query) aggregation)Watch)document)AnyCallable GeneratorTupleUnion) TransactioncsLeZdZdZddfdd ZejdddZej ddd Z de j j dfeeedfejeedfeeefd d d Zde j j dfeedfejeedfeeedfd ddZedddZde j j dfeedfejeedfedddZde j j dfeedfejeedfeejedfdddZ e!e"dddZ#Z$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. N)returncstt|j|i|dSN)superr__init__)selfpathkwargs __class__e/var/www/html/python-backend/venv/lib/python3.9/site-packages/google/cloud/firestore_v1/collection.pyr<szCollectionReference.__init__cCs t|S)zeQuery factory. Returns: :class:`~google.cloud.firestore_v1.query.Query` ) query_modQueryrrrr_query?szCollectionReference._querycCst|S)zAggregationQuery factory. Returns: :class:`~google.cloud.firestore_v1.aggregation_query.AggregationQuery` )rAggregationQueryrrrrr_aggregation_queryGsz&CollectionReference._aggregation_query) document_data document_idrtimeoutrcCs0|||||\}}|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. )Z _prep_addcreateZ update_time)rr"r#rr$Z document_refrZ write_resultrrraddOs"zCollectionReference.add) page_sizerr$rcsB|||\}}jjjf|jjd|}fdd|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 )requestmetadatac3s|]}t|VqdSr)r).0irrr z5CollectionReference.list_documents..)Z_prep_list_documentsZ_clientZ_firestore_apilist_documentsZ _rpc_metadata)rr'rr$r(riteratorrrrr.zs z"CollectionReference.list_documents) chunk_sizecCs||Sr)r _chunkify)rr0rrrr1szCollectionReference._chunkify) transactionrr$rcCs$|||\}}|jfd|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. r2)_prep_get_or_streamgetrr2rr$rrrrrr4szCollectionReference.getcCs$|||\}}|jfd|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. r2)r3streamr5rrrr6s$zCollectionReference.stream)callbackrcCs|}t||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() )rrZ for_queryr DocumentSnapshot)rr7rrrr on_snapshotszCollectionReference.on_snapshot)%__name__ __module__ __qualname____doc__rrrrrr r!rmethodDEFAULTdictrstrretriesRetryfloatr r r&intr r.r1rlistr4r r8r6r rr9 __classcell__rrrrr"sV    -      !   (rN)r=Zgoogle.api_corerrrBZ)google.cloud.firestore_v1.base_collectionrrZgoogle.cloud.firestore_v1rrrZgoogle.cloud.firestore_v1.watchrr typingr r r r rZ%google.cloud.firestore_v1.transactionrrrrrrs