docs: expand documentation on transactions #1539
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
product-auto-label
bot
added
the
api: firestore
google-cla
bot
added
the
cla: yes
thebrianchen
approved these changes
Jun 23, 2021
dev/src/index.ts
Outdated
| * out or fails for any reason. | ||
| * | ||
| * Transactions are committed once 'updateFunction' resolves. If a transaction | ||
| * fails with contention, the transaction is retried five up to five times and |
There was a problem hiding this comment.
"transaction is retried up to five times"
Also, the current wording makes it seem that the updateFunction is only invoked after the retries are completed, which could be misleading.
There was a problem hiding this comment.
Changed the wording.
dev/src/index.ts
Outdated
| * fails with contention, the transaction is retried five up to five times and | ||
| * its `updateFunction` is invoked again. | ||
| * | ||
| * Transaction time out after 270 seconds or 60 seconds of after the last |
There was a problem hiding this comment.
nits:
s/Transaction/Transactions
s/60 seconds of after/seconds after
"last document is read"
Also, when does the timeout change from 60s to 270s? If a document is read in a tx, is the timeout window reduced to 60s + write-only tx timeout have a 270s timeout?
There was a problem hiding this comment.
Changed to:
* Transactions time out after 60 seconds if no documents are read.
* Transactions that are not committed within than 270 seconds are also
* aborted.
…is/nodejs-firestore into mrschmidt/bettertransactiondocs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1221