Module async_transaction (2.17.2)

Helpers for applying Google Cloud Firestore changes in a transaction.

Classes

AsyncTransaction

AsyncTransaction(client, max_attempts=5, read_only=False)

Accumulate read-and-write operations to be sent in a transaction.

Parameters
Name Description
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 MAX_ATTEMPTS.
read_only Optional[bool]

Flag indicating if the transaction should be read-only or should allow writes. Defaults to :data:False.

Modules Functions

async_transactional

async_transactional(
    to_wrap: typing.Callable[
        [google.cloud.firestore_v1.async_transaction.AsyncTransaction], typing.Any
    ]
) -> google.cloud.firestore_v1.async_transaction._AsyncTransactional

Decorate a callable so that it runs in a transaction.

Parameter
Name Description
to_wrap typing.Callable[[google.cloud.firestore_v1.async_transaction.AsyncTransaction], typing.Any]

(Callable[[Transaction, ...], Any]): A callable that should be run (and retried) in a transaction.
Returns
Type Description
Callable[[Transaction, ...], Any] the wrapped callable.