Ѯh-dZddlmZddlmZmZmZmZmZddl m Z ddl m Z ddl mZmZmZmZmZddlmZmZddlmZerdd lmZdd lmZdd lmZdd lmZGd deej@Z!y)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)QueryResultsListceZdZdZdfd ZddZddZddZddZde jjdf ddZ d dfd Z de jjdf dd Zde jjdfdd  dd Zde jjdfdd  dd ZxZS)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. c,tt| |i|yN)superr__init__)selfpathkwargs __class__s |/home/www/academy-backend.kofcorporation.com/venv/lib/python3.12/site-packages/google/cloud/firestore_v1/async_collection.pyrz!AsyncCollectionReference.__init__Es &6GGc,tj|S)zeQuery factory. Returns: :class:`~google.cloud.firestore_v1.query.Query` )r AsyncQueryrs r!_queryzAsyncCollectionReference._queryHs %%d++r"cHtj|jS)zAsyncAggregationQuery factory. Returns: :class:`~google.cloud.firestore_v1.async_aggregation.AsyncAggregationQuery )r AsyncAggregationQueryr&r%s r!_aggregation_queryz+AsyncCollectionReference._aggregation_queryPs !66t{{}EEr"cHtj|jS)zAsyncVectorQuery factory. Returns: :class:`~google.cloud.firestore_v1.async_vector_query.AsyncVectorQuery` )rAsyncVectorQueryr&r%s r! _vector_queryz&AsyncCollectionReference._vector_queryXs "224;;=AAr"cnK|jj|23d{}|7 6ywr)r& _chunkify)r chunk_sizepages r!r.z"AsyncCollectionReference._chunkify`s4++-11*=  $J =s 5313535NcK|j||||\}}|j|fi|d{}|j|fS7w)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)r document_data document_idretrytimeout document_refr write_results r!addzAsyncCollectionReference.addds[D $~~       f 1\00I&II ''55Js.AAAc*tt| |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)rr6r s r!r=z!AsyncCollectionReference.documents-t=kJJr"cK|j|||\}}|jjjd||jjd|d{}|23d{}t ||776yw)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)_prep_list_documents_client_firestore_apilist_documents _rpc_metadatar)r page_sizer7r8r?riteratoris r!rEz'AsyncCollectionReference.list_documentss.33IugNC44CC \\//      1 1!'a0 0   1xs6AA?A9A? A=$A;%A=(A?;A==A?)explain_optionsc~K|j||\}}|||d<|jdd|i|d{S7w)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. NrJrrA)_prep_get_or_streamgetrrr7r8rJqueryrs r!rMzAsyncCollectionReference.getsOD00@ v  &(7F$ %UYYA;A&AAAAs 4=;=cb|j||\}}|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. rJrrA)rLstreamrNs r!rQzAsyncCollectionReference.streamsBV00@ v (7F$ %u||> >v>>r")returnNone)rRzasync_query.AsyncQuery)rRz'async_aggregation.AsyncAggregationQuery)rRz#async_vector_query.AsyncVectorQuery)r/int) r5dictr6 str | Noner7"retries.AsyncRetry | object | Noner8 float | NonerRzTuple[Any, Any]r)r6rVrRz%async_document.AsyncDocumentReference)rGz int | Noner7rWr8rXrRz'AsyncGenerator[DocumentReference, None]) r!Optional[transaction.Transaction]r7rWr8Optional[float]rJOptional[ExplainOptions]rRz"QueryResultsList[DocumentSnapshot]) rrYr7rWr8rZrJr[rRz&AsyncStreamGenerator[DocumentSnapshot])__name__ __module__ __qualname____doc__rr&r)r,r.r methodDEFAULTr;r=rErMrQ __classcell__)r s@r!rr+s}2H,FB#'444rnsXO"FF$2AUHFHm?6{7M7MNm?r"