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.

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

chore: add note about preference of stream() to get() #3972

Merged
merged 5 commits into from
Jun 5, 2020

Conversation

sdlin
Copy link
Contributor

@sdlin sdlin commented Jun 5, 2020

This snippet is used in these docs:
https://cloud.google.com/firestore/docs/query-data/queries#python_3

Which say:

After creating a query object, use the get() function to retrieve the results:

That's true for the other languages, but not for Python, which has deprecated get() and replaced it with stream(), based on these docs:
https://googleapis.dev/python/firestore/latest/collection.html#google.cloud.firestore_v1.collection.CollectionReference.get

@sdlin sdlin requested a review from a team as a code owner June 5, 2020 00:27
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jun 5, 2020
@BenWhitehead BenWhitehead added kokoro:run Add this label to force Kokoro to re-run the tests. automerge Merge the pull request once unit tests and other checks pass. labels Jun 5, 2020
firestore/cloud-client/snippets.py Outdated Show resolved Hide resolved
@kokoro-team kokoro-team removed the kokoro:run Add this label to force Kokoro to re-run the tests. label Jun 5, 2020
@BenWhitehead BenWhitehead added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jun 5, 2020
@BenWhitehead BenWhitehead changed the title Add note about CollectionRef get deprecation chore: add note about preference of stream() to get() Jun 5, 2020
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jun 5, 2020
@gcf-merge-on-green
Copy link
Contributor

Your PR has attempted to merge for 3 hours. Please check that all required checks have passed, you have an automerge label, and that all your reviewers have approved the PR

@BenWhitehead BenWhitehead added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jun 5, 2020
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jun 5, 2020
@tmatsuo tmatsuo added kokoro:force-run Add this label to force Kokoro to re-run the tests. and removed automerge Merge the pull request once unit tests and other checks pass. labels Jun 5, 2020
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jun 5, 2020
@tmatsuo tmatsuo merged commit f3a9eef into GoogleCloudPlatform:master Jun 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants