o ˷e%@sdZddlmZddlmZddlmZmZddlm Z m Z ddl m Z ddl mZddl mZmZmZdd lmZGd d d eZd S) zHClasses for representing collections for the Google Cloud Firestore API.)gapic_v1)retry)BaseCollectionReference_item_to_document_ref) async_queryasync_document)DocumentReference) AsyncIterator)AnyAsyncGeneratorTuple) Transactionc seZdZdZdfdd ZdejfddZdefd d Z de j j dfd e d ed ejdedeeeff ddZ dd edejffdd Zde j j dfded ejdedeedffddZde j j dfded ejdedefddZde j j dfded ejdedeejfddZ Z!S)AsyncCollectionReferencea 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. returnNcstt|j|i|dSN)superr__init__)selfpathkwargs __class__a/var/www/ideatree/venv/lib/python3.10/site-packages/google/cloud/firestore_v1/async_collection.pyr@sz!AsyncCollectionReference.__init__cCs t|S)zeQuery factory. Returns: :class:`~google.cloud.firestore_v1.query.Query` )r AsyncQuery)rrrr_queryCs zAsyncCollectionReference._query chunk_sizecCs*||2z 3dHW}|Vq6dSr)r _chunkify)rrpagerrrrKsz"AsyncCollectionReference._chunkify document_data document_idrtimeoutcs8|||||\}}|j|fi|IdH}|j|fS)a Create 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.async_document.AsyncDocumentReference`]: 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. N) _prep_addcreate update_time)rrr rr! document_refr write_resultrrraddOs" zAsyncCollectionReference.addcstt||S)aCreate a sub-document underneath the current collection. Args: document_id (Optional[str]): The document identifier within the current collection. If not provided, will default to a random 20 character string composed of digits, uppercase and lowercase and letters. Returns: :class:`~google.cloud.firestore_v1.document.async_document.AsyncDocumentReference`: The child document. )rrdocument)rr rrrr(zsz!AsyncCollectionReference.document page_sizecCs\||||\}}|jjjd||jjd|IdH}|2z 3dHW}t||Vq6dS)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 )requestmetadataNr)_prep_list_documents_client_firestore_apilist_documents _rpc_metadatar)rr)rr!r*riteratorirrrr/s  z'AsyncCollectionReference.list_documents transactioncs,|||\}}|jdd|i|IdHS)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. r3Nr)_prep_get_or_streamget)rr3rr!queryrrrrr5szAsyncCollectionReference.getcCs@|||\}}|jdd|i|2z 3dHW}|Vq6dS)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. r3Nr)r4stream)rr3rr!r6rdrrrr7s $ zAsyncCollectionReference.stream)rNr)"__name__ __module__ __qualname____doc__rrrrintrrmethodDEFAULTdictstrretriesRetryfloatr r r'rAsyncDocumentReferencer(r rr/r listr5r DocumentSnapshotr7 __classcell__rrrrr&sz  ,  # !rN)r<google.api_corerrrB)google.cloud.firestore_v1.base_collectionrrgoogle.cloud.firestore_v1rr"google.cloud.firestore_v1.documentrtypingr r r r %google.cloud.firestore_v1.transactionr rrrrrs