U >i-@sdZddlmZddlmZmZmZmZmZddl m Z ddl m Z ddl mZmZmZmZmZddlmZmZddlmZerdd 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)QueryResultsListcseZdZdZddfdd ZddddZd dd d Zd dd dZddddZde j j dfddddddddZ d0dddfdd Z de j j dfd ddd!d"d#d$Zde j j dfdd%d&dd'd(d)d*d+d,Zde j j dfdd%d&dd'd(d-d*d.d/ZZS)1AsyncCollectionReferencea 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. None)returncstt|j||dSN)superr__init__)selfpathkwargs __class__N/tmp/pip-unpacked-wheel-599y42ri/google/cloud/firestore_v1/async_collection.pyrEsz!AsyncCollectionReference.__init__zasync_query.AsyncQuerycCs t|S)zeQuery factory. Returns: :class:`~google.cloud.firestore_v1.query.Query` )r AsyncQueryrr!r!r"_queryHszAsyncCollectionReference._queryz'async_aggregation.AsyncAggregationQuerycCst|S)zAsyncAggregationQuery factory. Returns: :class:`~google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery )r ZAsyncAggregationQueryr%r$r!r!r"_aggregation_queryPsz+AsyncCollectionReference._aggregation_queryz#async_vector_query.AsyncVectorQuerycCst|S)zAsyncVectorQuery factory. Returns: :class:`~google.cloud.firestore_v1.async_vector_query.AsyncVectorQuery` )r ZAsyncVectorQueryr%r$r!r!r" _vector_queryXsz&AsyncCollectionReference._vector_queryint) chunk_sizecCs(||2z3dHW}|Vq6dSr)r% _chunkify)rr)pager!r!r"r*`sz"AsyncCollectionReference._chunkifyNdictz str | Nonez"retries.AsyncRetry | object | Nonez float | NonezTuple[Any, Any]) document_data document_idretrytimeoutrcs2|||||\}}|j|f|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)Z _prep_addcreateZ update_time)rr-r.r/r0Z document_refrZ write_resultr!r!r"addds"zAsyncCollectionReference.addz%async_document.AsyncDocumentReference)r.rcstt||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.rr!r"r3sz!AsyncCollectionReference.documentz int | Nonez'AsyncGenerator[DocumentReference, None]) page_sizer/r0rcCsZ||||\}}|jjjf||jjd|IdH}|2z3dHW}t||Vq:6dS)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 )requestmetadataN)Z_prep_list_documentsZ_clientZ_firestore_apilist_documentsZ _rpc_metadatar)rr4r/r0r5riteratorir!r!r"r7s  z'AsyncCollectionReference.list_documents)explain_optionsz!Optional[transaction.Transaction]zOptional[float]zOptional[ExplainOptions]z"QueryResultsList[DocumentSnapshot])rr/r0r:rcs:|||\}}|dk r ||d<|jfd|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. Nr:r)_prep_get_or_streamgetrrr/r0r:queryrr!r!r"r<s"zAsyncCollectionReference.getz&AsyncStreamGenerator[DocumentSnapshot]cCs0|||\}}|r||d<|jfd|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. r:r)r;streamr=r!r!r"r?s+zAsyncCollectionReference.stream)N)__name__ __module__ __qualname____doc__rr%r&r'r*rmethodDEFAULTr2r3r7r<r? __classcell__r!r!rr"r+s8,#*rN)"rC __future__rtypingrrrrrZgoogle.api_corerr retriesZgoogle.cloud.firestore_v1r r r r rZ)google.cloud.firestore_v1.base_collectionrrZ"google.cloud.firestore_v1.documentrZ0google.cloud.firestore_v1.async_stream_generatorrZ'google.cloud.firestore_v1.base_documentrZ'google.cloud.firestore_v1.query_profilerZ'google.cloud.firestore_v1.query_resultsrr#rr!r!r!r"s