(ph2SrSSKJr SSKJrJrJrJrJr SSK J r J r SSK J r SSKJrJr SSKJrJrJrJrJrJrJrJr SSKJr SS KJr \(aSS KJr SS K J!r! SS K"J#r# "S S\RH\5r%"SS\5r&SSjr'g)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)StreamGeneratorc^\rSrSrSr\S4SU4SjjjrSU4SjjrSSSjjrSSjr SS jr \ RRS4SS jjr\ RRS4SS .SS jjjrS rU=r$) Transaction,aAccumulate 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`. FcZ>[[U] U5 [R"XU5 gN)superr__init__r)selfclient max_attempts read_only __class__s X/var/www/html/venv/lib/python3.13/site-packages/google/cloud/firestore_v1/transaction.pyr!Transaction.__init__:s" k4)&1  Y?cl>UR(a[[5e[[U]U5 g)zAdd `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 ValueErrorrr r_add_write_pbs)r" write_pbsr&s r'r-Transaction._add_write_pbs>s' ??-. . k4/ :r)NcZUR(a+[R"UR5n[ U5eUR R RUR RURU5S.UR RS9nURUlg)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_progressrformat_idr,_client_firestore_apibegin_transaction_database_string_options_protobuf _rpc_metadata transaction)r"retry_idmsgtransaction_responses r'_beginTransaction._beginMs   $$TXX.CS/ !#||::LL LL9911(;\\// M (33r)cBUR(d[[5eURRR URR URS.URRS9 UR5 g!UR5 f=f)zRoll back the transaction. Raises: ValueError: If no transaction is in progress. google.api_core.exceptions.GoogleAPICallError: If the rollback fails. )r1r?r3N) r6r,rr9r:rollbackr<r8r> _clean_up)r"s r' _rollbackTransaction._rollbackdsy^, ,  LL ' ' 0 0 $ = =#'8833 1  NN DNN s AB BcUR(d[[5eURRR URR URURS.URRS9nUR5 [UR5Ul URUl UR$)a~Transactionally 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. )r1writesr?r3)r6r,rr9r:commitr< _write_pbsr8r>rGlist write_results commit_time)r"commit_responses r'_commitTransaction._commit{s\* *,,55<< LL99//#xx \\// =  !/"?"?@*66!!!r)cl[R"X#5nURR"U4SU0UD6$)aRetrieves 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_kwargsr9get_all)r" referencesr timeoutkwargss r'rVTransaction.get_alls3(33EC||##JKDKFKKr))explain_optionsc*[R"X#5n[U[5(a.Ub [ S5eUR R "U/4SU0UD6$[U[5(aUbXES'UR"SSU0UD6$[ S5e)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. z^When type of `ref_or_query` is `AsyncDocumentReference`, `explain_options` cannot be provided.r?r[zIValue for argument "ref_or_query" must be a DocumentReference or a Query.) r rU isinstancerr,r9rVrstream)r" ref_or_queryr rXr[rYs r'getTransaction.gets@33EC l$5 6 6* <<<''SDSFS S  e , ,*,;()&&B4B6B B[ r))r8rPrOreturnNone)r.rNrdrer)r@z bytes | Nonerdre)rdrN)rWrNr retries.Retry | object | NonerXz float | Nonerdz&Generator[DocumentSnapshot, Any, None]) r`zDocumentReference | Queryr rfrXzOptional[float]r[zOptional[ExplainOptions]rdzJStreamGenerator[DocumentSnapshot] | Generator[DocumentSnapshot, Any, None])__name__ __module__ __qualname____firstlineno____doc__rr!r-rCrHrRr methodDEFAULTrVra__static_attributes__ __classcell__r&s@r'rr,s -9E@@ ;4.."@08/F/F $ LL-L L 0 L408/F/F#' / 59 ///-/! / 2 / T//r)rcD^\rSrSrSrSU4SjjrSSjrS SjrSrU=r $) _TransactionalaAProvide 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. c,>[[U] U5 gr)r rrr!)r"to_wrapr&s r'r!_Transactional.__init__s nd,W5r)cUR5 URURS9 URUlURcURUlUR "U/UQ70UD6$)aBegin 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@)rGrCr@r8 current_idru)r"r?argsrYs r' _pre_commit_Transactional._pre_commits`& DMM2&// ==  OODM||K9$9&99r)cUR5 UR(d[ROSnSn[ UR 5H,nUR "U/UQ70UD6nUR5 Us $ [R"UR 5n [U 5Ue!Ua nUnSnAMjSnAff=f![a UR5 ef=f)a*Execute 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+r Abortedrange _max_attemptsrzrRrr7r, BaseExceptionrH) r"r?ryrYretryable_exceptionslast_excattemptresultexcrAs r'__call___Transactional.__call__ s& (3(>(>Z  B   !:!:;))+GGG#'')!M <,22;3L3LMCS/x /,#"H#   ! ! #   s;.B>&B(7B>:.B>(B;.B60B>6B;;B>>C)rxr@rc)r?rrdr)r?r) rgrhrirjrkr!rzrrnrorps@r'rrrrs6:8//r)rrc[U5$)agDecorate 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. )rr)rus r' transactionalr=s ' ""r)N)rurrdrr)(rk __future__rtypingrrrrrgoogle.api_corer r r retriesgoogle.cloud.firestore_v1r r *google.cloud.firestore_v1.base_transactionrrrrrrrr"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 WriteBatchrrrrr]r)r'rsoL"DD0,5   A1HFJr%""OrjY'Yx #r)