Skip to content
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

Jump to bottom

Add a snippet demonstrating a stale read. #1271

Open
jlara310 opened this issue Apr 25, 2023 · 3 comments · May be fixed by #1273
Open

Add a snippet demonstrating a stale read. #1271

jlara310 opened this issue Apr 25, 2023 · 3 comments · May be fixed by #1273
Assignees
@jlara310
Labels
api: firestore Issues related to the googleapis/java-firestore API. documentation Improvements or additions to documentation type: docs Improvement to the documentation for an API.

Comments

@jlara310
Copy link
Contributor

We need a Firestore snippet that demonstrates how to set read options to perform a stale read. A stale read can improve latency for request that don't require strong consistency.

File to update:

https://github.com/googleapis/java-firestore/blob/main/samples/snippets/src/main/java/com/example/firestore/snippets/ManageDataSnippets.java
@product-auto-label product-auto-label bot added the api: firestore Issues related to the googleapis/java-firestore API. label Apr 25, 2023
@MarkDuckworth MarkDuckworth self-assigned this Apr 25, 2023
@MarkDuckworth
Copy link
Contributor

@jlara310, can you provide some additional information about what java-firestore API the snippet should demonstrate? I'm not familiar with stale reads and I can't find an API member that looks relevant.

@jlara310 jlara310 linked a pull request Apr 26, 2023 that will close this issue
Open
@jlara310
Copy link
Contributor Author

@MarkDuckworth , thank for the quick reply! I started a PR for this in #1273. This snippet is very similar to this one but the use case is performance instead of data recovery.

@MarkDuckworth
Copy link
Contributor

@jlara310, Okay, it seems like you are implementing this, so I'm going to re-assign this issue to you. Assign back if I misunderstood. BTW, the PR looks good so far. Feel free to add me as a reviewer when it is ready.

@MarkDuckworth MarkDuckworth added type: docs Improvement to the documentation for an API. documentation Improvements or additions to documentation labels Apr 26, 2023
@MarkDuckworth MarkDuckworth removed their assignment Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jlara310 jlara310

Labels
api: firestore Issues related to the googleapis/java-firestore API. documentation Improvements or additions to documentation type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

samples: Add example snippets for stale reads jlara310/java-firestore
2 participants
@MarkDuckworth @jlara310