Skip to content

Adding documentation for WriteBatch size limit #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 30, 2019
Merged

Adding documentation for WriteBatch size limit #392

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb607a1
update documentation
Apr 30, 2019
ae38a18
add batch comment
Apr 30, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,6 +263,10 @@ public Query collectionGroup(@NonNull String collectionId) {
* transaction. If any document read within the transaction has changed, the updateFunction will
* be retried. If it fails to commit after 5 attempts, the transaction will fail.
*
* <p>The maximum number of writes allowed in a single transaction is 500, but note that each
* usage of FieldValue.serverTimestamp(), FieldValue.arrayUnion(), FieldValue.arrayRemove(), or
* FieldValue.increment() inside a transaction counts as an additional write.
*
* @param updateFunction The function to execute within the transaction context.
* @param executor The executor to run the transaction callback on.
* @return The task returned from the updateFunction.
Expand Down Expand Up @@ -306,6 +310,10 @@ public <TResult> Task<TResult> runTransaction(
/**
* Creates a write batch, used for performing multiple writes as a single atomic operation.
*
* <p>The maximum number of writes allowed in a single transaction is 500, but note that each
* usage of FieldValue.serverTimestamp(), FieldValue.arrayUnion(), FieldValue.arrayRemove(), or
* FieldValue.increment() inside a transaction counts as an additional write.
*
* @return The created WriteBatch object.
*/
@NonNull
Expand Down