feat: add read-only transactions #1541
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 28, 2021
types/firestore.d.ts
Outdated
| * document. A transaction releases its document locks at commit time or if | ||
| * it fails for any reason. | ||
| * | ||
| * Read-only transaction do not lock documents. They can be used to read |
dev/src/index.ts
Outdated
| * writes, and other non-transactional writes from changing that document. | ||
| * A transaction releases its document locks at commit time or once it times | ||
| * out or fails for any reason. | ||
| * Transaction can be performed as read-only or read-write transactions. By |
|
|
||
| readOnly = true; | ||
| readTime = transactionOptions.readTime as Timestamp | undefined; | ||
| maxAttempts = 1; |
There was a problem hiding this comment.
optional: specify that read-only transactions not retried in the documentation.
There was a problem hiding this comment.
Done (might make sense for you to do a quick sanity check on the result)
| expect(snapshot.get('foo')).to.equal(1); | ||
| }); | ||
|
|
||
| it('fails read-only with writes', async () => { |
There was a problem hiding this comment.
optional: verify that the tx was not retried.
There was a problem hiding this comment.
"Sebastian goes above and beyond"
types/firestore.d.ts
Outdated
| @@ -174,6 +174,28 @@ declare namespace FirebaseFirestore { | |||
| [key: string]: any; // Accept other properties, such as GRPC settings. | |||
| } | |||
|
|
|||
| /** Options to configure a read-only transaction. */ | |||
| export interface ReadOnlyTransactionOptions { | |||
| /** Set to true to indicate a read-write transaction. */ | |||
types/firestore.d.ts
Outdated
|
|
||
| /** Options to configure a read-write transaction. */ | ||
| export interface ReadWriteTransactionOptions { | ||
| /** Set to false or omitted to start a read-write transaction. */ |
gcf-merge-on-green bot
pushed a commit
that referenced
this pull request
Jun 29, 2021
🤖 I have created a release \*beep\* \*boop\* --- ## [4.13.0](https://github.com/googleapis/nodejs-firestore/compare/v4.12.3...v4.13.0) (2021-06-29) ### Features * add read-only transactions ([#1541](https://github.com/googleapis/nodejs-firestore/issues/1541)) ([ca4241e](https://github.com/googleapis/nodejs-firestore/commit/ca4241eb3ee4abb8453b6da0911397187dc18dde)) * retry BatchGetDocuments RPCs that fail with errors ([#1544](https://github.com/googleapis/nodejs-firestore/issues/1544)) ([b39dd3c](https://github.com/googleapis/nodejs-firestore/commit/b39dd3c65549fb1a651c1722d8ea2c038e152417)) ### Bug Fixes * **deps:** google-gax v2.17.0 with mTLS ([#1546](https://github.com/googleapis/nodejs-firestore/issues/1546)) ([a322345](https://github.com/googleapis/nodejs-firestore/commit/a32234510d487982b950c88575b9425c531c2d94)) * make request optional in all cases ([#1536](https://github.com/googleapis/nodejs-firestore/issues/1536)) ([f6edfc1](https://github.com/googleapis/nodejs-firestore/commit/f6edfc181ca39cd307eab6d141db08f377d5cfdf)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
This adds read-only transactions to Firestore Node. They are already available in Java.
Fixes #1245