com.google.cloud.firestore

Class Transaction

java.lang.Object

com.google.cloud.firestore.UpdateBuilder<Transaction>

com.google.cloud.firestore.Transaction

public final class Transaction
extends UpdateBuilder<Transaction>

A Transaction is passed to a Function to provide the methods to read and write data within the transaction context.

See Also:

Firestore#runTransaction(Function)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Transaction.Function<T> User callback that takes a Firestore Transaction

Method Summary

Modifier and Type	Method and Description
ApiFuture<DocumentSnapshot>	get(DocumentReference documentRef) Reads the document referred to by the provided DocumentReference.
ApiFuture<QuerySnapshot>	get(Query query) Returns the result set from the provided query.
ApiFuture<List<DocumentSnapshot>>	getAll(DocumentReference... documentReferences) Retrieves multiple documents from Firestore.
ApiFuture<List<DocumentSnapshot>>	getAll(DocumentReference[] documentReferences, FieldMask fieldMask) Retrieves multiple documents from Firestore, while optionally applying a field mask to reduce the amount of data transmitted from the backend.

Methods inherited from class com.google.cloud.firestore.UpdateBuilder

create, create, delete, delete, getMutationsSize, set, set, set, set, update, update, update, update, update, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

@Nonnull
public ApiFuture<DocumentSnapshot> get(@Nonnull
                                                DocumentReference documentRef)

Reads the document referred to by the provided DocumentReference. Holds a pessimistic lock on the returned document.

Returns:

The contents of the Document at this DocumentReference.

getAll

@Nonnull
public ApiFuture<List<DocumentSnapshot>> getAll(@Nonnull
                                                         DocumentReference... documentReferences)

Retrieves multiple documents from Firestore. Holds a pessimistic lock on all returned documents.

Parameters:

documentReferences - List of Document References to fetch.

getAll

@Nonnull
public ApiFuture<List<DocumentSnapshot>> getAll(@Nonnull
                                                         DocumentReference[] documentReferences,
                                                         @Nullable
                                                         FieldMask fieldMask)

Retrieves multiple documents from Firestore, while optionally applying a field mask to reduce the amount of data transmitted from the backend. Holds a pessimistic lock on all returned documents.

Parameters:

documentReferences - Array with Document References to fetch.

fieldMask - If set, specifies the subset of fields to return.

get

@Nonnull
public ApiFuture<QuerySnapshot> get(@Nonnull
                                             Query query)

Returns the result set from the provided query. Holds a pessimistic lock on all returned documents.

Returns:

The contents of the Document at this DocumentReference.