Module transaction (2.5.2)

Helpers for applying Google Cloud Firestore changes in a transaction.

Classes

Transaction

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

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

Parameters
NameDescription
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

transactional

transactional(to_wrap: Callable)

Decorate a callable so that it runs in a transaction.

Returns
TypeDescription
Callable[[Transaction, ...], Any]the wrapped callable.