o  i2@sdZddlmZddlmZmZmZmZmZddl m Z m Z ddl m Z ddlmZmZddlmZmZmZmZmZmZmZmZddlmZdd lmZer`dd lmZdd l m!Z!dd l"m#Z#Gd ddej$eZ%GdddeZ&dddZ'dS)zEHelpers for applying Google Cloud Firestore changes in a transaction.) annotations) TYPE_CHECKINGAnyCallable GeneratorOptional) exceptionsgapic_v1)retry)_helpersbatch) _CANT_BEGIN _CANT_COMMIT_CANT_ROLLBACK_EXCEED_ATTEMPTS_TEMPLATE_WRITE_READ_ONLY MAX_ATTEMPTSBaseTransaction_BaseTransactional)DocumentReference)Query)DocumentSnapshot)ExplainOptions)StreamGeneratorcseZdZdZedfd%fdd Zd&fd d Zd'd(ddZd%ddZd)ddZ e j j d fd*ddZ e j j d fd dd+d#d$ZZS), TransactionaDAccumulate read-and-write operations to be sent in a transaction. Args: client (:class:`~google.cloud.firestore_v1.client.Client`): The client that created this transaction. max_attempts (Optional[int]): The maximum number of attempts for the transaction (i.e. allowing retries). Defaults to :attr:`~google.cloud.firestore_v1.transaction.MAX_ATTEMPTS`. read_only (Optional[bool]): Flag indicating if the transaction should be read-only or should allow writes. Defaults to :data:`False`. FreturnNonecs"tt||t|||dSN)superr__init__r)selfclient max_attempts read_only __class__/var/www/snowflake_co_dev_github/snow_flake_back_end_deploy/env/lib/python3.10/site-packages/google/cloud/firestore_v1/transaction.pyr:szTransaction.__init__ write_pbslistcs"|jrtttt||dS)a Add `Write`` protobufs to this transaction. Args: write_pbs (List[google.cloud.firestore_v1. write.Write]): A list of write protobufs to be added. Raises: ValueError: If this transaction is read-only. N) _read_only ValueErrorrrr_add_write_pbs)r r(r$r&r'r,>s zTransaction._add_write_pbsNretry_id bytes | NonecCsL|jr t|j}t||jjj|jj| |d|jj d}|j |_dS)zBegin the transaction. Args: retry_id (Optional[bytes]): Transaction ID of a transaction to be retried. Raises: ValueError: If the current transaction has already begun. )databaseoptionsrequestmetadataN) in_progressr format_idr+_client_firestore_apibegin_transaction_database_string_options_protobuf _rpc_metadata transaction)r r-msgtransaction_responser&r&r'_beginMs  zTransaction._begincCsJ|jsttz|jjj|jj|jd|jjdW| dS| w)zRoll back the transaction. Raises: ValueError: If no transaction is in progress. google.api_core.exceptions.GoogleAPICallError: If the rollback fails. )r/r=r1N) r4r+rr7r8rollbackr:r6r< _clean_up)r r&r&r' _rollbackds zTransaction._rollbackcCsV|jstt|jjj|jj|j|jd|jj d}| t |j |_ |j |_ |j S)aTransactionally commit the changes accumulated. Returns: List[:class:`google.cloud.firestore_v1.write.WriteResult`, ...]: The write results corresponding to the changes committed, returned in the same order as the changes were applied to this transaction. A write result contains an ``update_time`` field. Raises: ValueError: If no transaction is in progress. )r/writesr=r1)r4r+rr7r8commitr: _write_pbsr6r<rBr) write_results commit_time)r commit_responser&r&r'_commit{s  zTransaction._commit referencesr retries.Retry | object | Nonetimeout float | None&Generator[DocumentSnapshot, Any, None]cCs$t||}|jj|fd|i|S)aoRetrieves multiple documents from Firestore. Args: references (List[.DocumentReference, ...]): Iterable of document references to be retrieved. 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: .DocumentSnapshot: The next document snapshot that fulfills the query, or :data:`None` if the document does not exist. r=)r make_retry_timeout_kwargsr7get_all)r rKr rMkwargsr&r&r'rQs zTransaction.get_all)explain_options ref_or_queryDocumentReference | QueryOptional[float]rSOptional[ExplainOptions]JStreamGenerator[DocumentSnapshot] | Generator[DocumentSnapshot, Any, None]cCsvt||}t|tr |durtd|jj|gfd|i|St|tr7|dur-||d<|jdd|i|Std)aRetrieve a document or a query result from the database. Args: ref_or_query (DocumentReference | Query): The document references or query object to return. 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. 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. Can only be used when running a query, not a document reference. Yields: .DocumentSnapshot: The next document snapshot that fulfills the query, or :data:`None` if the document does not exist. Raises: ValueError: if `ref_or_query` is not one of the supported types, or explain_options is provided when `ref_or_query` is a document reference. Nz^When type of `ref_or_query` is `AsyncDocumentReference`, `explain_options` cannot be provided.r=rSzIValue for argument "ref_or_query" must be a DocumentReference or a Query.r&) r rP isinstancerr+r7rQrstream)r rTr rMrSrRr&r&r'gets  zTransaction.getrr)r(r)rrr)r-r.rr)rr))rKr)r rLrMrNrrO) rTrUr rLrMrVrSrWrrX)__name__ __module__ __qualname____doc__rrr,r@rCrJr methodDEFAULTrQr[ __classcell__r&r&r$r'r,s      rcs6eZdZdZd fdd Zdd d Zdd d ZZS)_TransactionalaYProvide a callable object to use as a transactional decorater. This is surfaced via :func:`~google.cloud.firestore_v1.transaction.transactional`. Args: to_wrap (Callable[[:class:`~google.cloud.firestore_v1.transaction.Transaction`, ...], Any]): A callable that should be run (and retried) in a transaction. rrcstt||dSr)rrdr)r to_wrapr$r&r'rsz_Transactional.__init__r=rrcOsH||j|jd|j|_|jdur|j|_|j|g|Ri|S)amBegin transaction and call the wrapped callable. Args: transaction (:class:`~google.cloud.firestore_v1.transaction.Transaction`): A transaction to execute the callable within. args (Tuple[Any, ...]): The extra positional arguments to pass along to the wrapped callable. kwargs (Dict[str, Any]): The extra keyword arguments to pass along to the wrapped callable. Returns: Any: result of the wrapped callable. Raises: Exception: Any failure caused by ``to_wrap``. )r-N)rBr@r-r6 current_idre)r r=argsrRr&r&r' _pre_commits  z_Transactional._pre_commitc Os||js tjnd}d}z=t|jD],}|j|g|Ri|}z ||WWS|y@}z|}WYd}~qd}~wwt |j} t | |t yW| w)aExecute the wrapped callable within a transaction. Args: transaction (:class:`~google.cloud.firestore_v1.transaction.Transaction`): A transaction to execute the callable within. args (Tuple[Any, ...]): The extra positional arguments to pass along to the wrapped callable. kwargs (Dict[str, Any]): The extra keyword arguments to pass along to the wrapped callable. Returns: Any: The result of the wrapped callable. Raises: ValueError: If the transaction does not succeed in ``max_attempts``. r&N) _resetr*rAbortedrange _max_attemptsrhrJrr5r+ BaseExceptionrC) r r=rgrRretryable_exceptionslast_excattemptresultexcr>r&r&r'__call__ s(   z_Transactional.__call__r\)r=rrr)r=r)r]r^r_r`rrhrsrcr&r&r$r'rds  rdrerrcCst|S)aDecorate a callable so that it runs in a transaction. Args: to_wrap (Callable[[:class:`~google.cloud.firestore_v1.transaction.Transaction`, ...], Any]): A callable that should be run (and retried) in a transaction. Returns: Callable[[:class:`~google.cloud.firestore_v1.transaction.Transaction`, ...], Any]: the wrapped callable. )rd)rer&r&r' transactional=s rtN)rerrrd)(r` __future__rtypingrrrrrgoogle.api_corerr r retriesgoogle.cloud.firestore_v1r r *google.cloud.firestore_v1.base_transactionr rrrrrrr"google.cloud.firestore_v1.documentrgoogle.cloud.firestore_v1.queryr'google.cloud.firestore_v1.base_documentr'google.cloud.firestore_v1.query_profiler*google.cloud.firestore_v1.stream_generatorr WriteBatchrrdrtr&r&r&r's"  (    6\