Class Transaction (3.1.0)

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)

Inheritance

java.lang.Object > UpdateBuilder > Transaction

Methods

get(DocumentReference documentRef)

public ApiFuture<DocumentSnapshot> get(DocumentReference documentRef)

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

Parameter
NameDescription
documentRefDocumentReference
Returns
TypeDescription
ApiFuture<DocumentSnapshot>

The contents of the Document at this DocumentReference.

get(Query query)

public ApiFuture<QuerySnapshot> get(Query query)

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

Parameter
NameDescription
queryQuery
Returns
TypeDescription
ApiFuture<QuerySnapshot>

The contents of the Document at this DocumentReference.

getAll(DocumentReference[] documentReferences)

public ApiFuture<List<DocumentSnapshot>> getAll(DocumentReference[] documentReferences)

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

Parameter
NameDescription
documentReferencesDocumentReference[]

List of Document References to fetch.

Returns
TypeDescription
ApiFuture<List<DocumentSnapshot>>

getAll(DocumentReference[] documentReferences, FieldMask fieldMask)

public 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. Holds a pessimistic lock on all returned documents.

Parameters
NameDescription
documentReferencesDocumentReference[]

Array with Document References to fetch.

fieldMaskFieldMask

If set, specifies the subset of fields to return.

Returns
TypeDescription
ApiFuture<List<DocumentSnapshot>>

hasTransactionId()

public boolean hasTransactionId()
Returns
TypeDescription
boolean