Module async_transaction (2.22.0)

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 AsyncClient

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[
        [
            typing_extensions.Concatenate[
                google.cloud.firestore_v1.async_transaction.AsyncTransaction, ~P
            ]
        ],
        typing.Awaitable[google.cloud.firestore_v1.async_transaction.T],
    ],
) -> typing.Callable[
    [
        typing_extensions.Concatenate[
            google.cloud.firestore_v1.async_transaction.AsyncTransaction, ~P
        ]
    ],
    typing.Awaitable[google.cloud.firestore_v1.async_transaction.T],
]

Decorate a callable so that it runs in a transaction.

Returns
Type Description
Callable[[Transaction, ...], Awaitable[Any]] the wrapped callable.