Class Transaction (3.1.0)

Version 3.1.0

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

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

Inherited Members

UpdateBuilder.create(DocumentReference,Object)

UpdateBuilder.create(DocumentReference,Map<String,Object>)

UpdateBuilder.delete(DocumentReference)

UpdateBuilder.delete(DocumentReference,Precondition)

UpdateBuilder.getMutationsSize()

UpdateBuilder.set(DocumentReference,Object)

UpdateBuilder.set(DocumentReference,Object,SetOptions)

UpdateBuilder.set(DocumentReference,Map<String,Object>)

UpdateBuilder.set(DocumentReference,Map<String,Object>,SetOptions)

UpdateBuilder.update(DocumentReference,FieldPath,Object,Object)

UpdateBuilder.update(DocumentReference,Precondition,FieldPath,Object,Object)

UpdateBuilder.update(DocumentReference,Precondition,String,Object,Object)

UpdateBuilder.update(DocumentReference,String,Object,Object)

UpdateBuilder.update(DocumentReference,Map<String,Object>)

UpdateBuilder.update(DocumentReference,Map<String,Object>,Precondition)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

Name	Description
documentRef	DocumentReference

Returns

Type	Description
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

Name	Description
query	Query

Returns

Type	Description
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

Name	Description
documentReferences	DocumentReference[] List of Document References to fetch.

Returns

Type	Description
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

Name	Description
documentReferences	DocumentReference[] Array with Document References to fetch.
fieldMask	FieldMask If set, specifies the subset of fields to return.

Returns

Type	Description
ApiFuture<List<DocumentSnapshot>>

hasTransactionId()

public boolean hasTransactionId()

Returns

Type	Description
boolean