Add quickstart demonstrating most BQ Storage API read features #7223
Conversation
This file contains hidden or 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
This snippet will be included at the bottom of the client library index page for the BigQuery Storage API. It will also be included in the docs at cloud.google.com. Adds a new session for nox to run the tests for samples in the docs directory. Acts as a system test of the rows() method.
tswast added the api: bigquerystorage 
googlebot added the cla: yes 
shollyman approved these changes Jan 30, 2019
There was a problem hiding this comment.
Thanks!
installation doc nit: we talk about the pip install for getting fastavro pretty deep in the comments, and the generated doc at https://googlecloudplatform.github.io/google-cloud-python/latest/bigquery_storage/index.html makes no mention of it. Should we augment the readme/docs for the library as well to mention the additional fastavro dependency, or handle it in another fashion?
parthea pushed a commit that referenced this pull request Aug 21, 2025
* Add quickstart demonstrating most BQ Storage API read features This snippet will be included at the bottom of the client library index page for the BigQuery Storage API. It will also be included in the docs at cloud.google.com. Adds a new session for nox to run the tests for samples in the docs directory. Acts as a system test of the rows() method. * s/handles reconnecting/reconnects/ * Add note about optional dependencies to readme.
parthea pushed a commit that referenced this pull request Sep 16, 2025
* Add quickstart demonstrating most BQ Storage API read features This snippet will be included at the bottom of the client library index page for the BigQuery Storage API. It will also be included in the docs at cloud.google.com. Adds a new session for nox to run the tests for samples in the docs directory. Acts as a system test of the rows() method. * s/handles reconnecting/reconnects/ * Add note about optional dependencies to readme.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
3 participants
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 snippet will be included at the bottom of the client
library index page for the BigQuery Storage API. It will
also be included in the docs at cloud.google.com.
Adds a new session for nox to run the tests for samples
in the docs directory. Acts as a system test of the rows()
method.