o  i-@sdZddlmZddlmZmZmZmZmZddl m Z ddl m Z ddl mZmZmZmZmZddlmZmZddlmZerXdd lmZdd lmZdd lmZdd lmZGd ddeej Z!dS)zHClasses for representing collections for the Google Cloud Firestore API.) annotations) TYPE_CHECKINGAnyAsyncGeneratorOptionalTuple)gapic_v1) retry_async)async_aggregationasync_document async_queryasync_vector_query transaction)BaseCollectionReference_item_to_document_ref)DocumentReference)AsyncStreamGenerator)DocumentSnapshot)ExplainOptions)QueryResultsListcseZdZdZd3fdd Zd4ddZd5d d Zd6d dZd7ddZde j j dfd8ddZ d9d:fd d! Z de j j dfd;d%d&Zde j j dfdd'dAsyncCollectionReferencea 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. returnNonecstt|j|i|dSN)superr__init__)selfpathkwargs __class__/var/www/snowflake_co_dev_github/snow_flake_back_end_deploy/env/lib/python3.10/site-packages/google/cloud/firestore_v1/async_collection.pyrEsz!AsyncCollectionReference.__init__async_query.AsyncQuerycCs t|S)zeQuery factory. Returns: :class:`~google.cloud.firestore_v1.query.Query` )r AsyncQueryrr!r!r"_queryHs zAsyncCollectionReference._query'async_aggregation.AsyncAggregationQuerycCt|S)zAsyncAggregationQuery factory. Returns: :class:`~google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery )r AsyncAggregationQueryr&r%r!r!r"_aggregation_queryPz+AsyncCollectionReference._aggregation_query#async_vector_query.AsyncVectorQuerycCr()zAsyncVectorQuery factory. Returns: :class:`~google.cloud.firestore_v1.async_vector_query.AsyncVectorQuery` )r AsyncVectorQueryr&r%r!r!r" _vector_queryXr+z&AsyncCollectionReference._vector_query chunk_sizeintcCs*||2z 3dHW}|Vq6dSr)r& _chunkify)rr/pager!r!r"r1`sz"AsyncCollectionReference._chunkifyN document_datadict document_id str | Noneretry"retries.AsyncRetry | object | Nonetimeout float | NoneTuple[Any, Any]cs8|||||\}}|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)rr3r5r7r9 document_refr write_resultr!r!r"addds" zAsyncCollectionReference.add%async_document.AsyncDocumentReferencecstt||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)rr5rr!r"rCsz!AsyncCollectionReference.document page_size int | None'AsyncGenerator[DocumentReference, None]cCs\||||\}}|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)rrDr7r9rGriteratorir!r!r"rLs  z'AsyncCollectionReference.list_documents)explain_optionsr!Optional[transaction.Transaction]Optional[float]rPOptional[ExplainOptions]"QueryResultsList[DocumentSnapshot]cs<|||\}}|dur||d<|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 (Optional[google.api_core.retry.Retry]): Designation of what errors, if any, should be retried. Defaults to a system-specified policy. timeout (Otional[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. NrPrr!)_prep_get_or_streamgetrrr7r9rPqueryrr!r!r"rVs "zAsyncCollectionReference.get&AsyncStreamGenerator[DocumentSnapshot]cCs0|||\}}|r||d<|jdd|i|S)a%Read the documents in this collection. 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. Returns: `AsyncStreamGenerator[DocumentSnapshot]`: A generator of the query results. rPrNr!)rUstreamrWr!r!r"rZs+zAsyncCollectionReference.stream)rr)rr#)rr')rr,)r/r0) r3r4r5r6r7r8r9r:rr;r)r5r6rrB)rDrEr7r8r9r:rrF) rrQr7r8r9rRrPrSrrT) rrQr7r8r9rRrPrSrrY)__name__ __module__ __qualname____doc__rr&r*r.r1rmethodDEFAULTrArCrLrVrZ __classcell__r!r!rr"r+s:     , #*rN)"r^ __future__rtypingrrrrrgoogle.api_corerr retriesgoogle.cloud.firestore_v1r r r r r)google.cloud.firestore_v1.base_collectionrr"google.cloud.firestore_v1.documentr0google.cloud.firestore_v1.async_stream_generatorr'google.cloud.firestore_v1.base_documentr'google.cloud.firestore_v1.query_profiler'google.cloud.firestore_v1.query_resultsrr$rr!r!r!r"s