Skip to content

Docs: document BigQuery Storage Read API usage in Python #37542

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

Open
Midhat-kazmi wants to merge 1 commit into
base: master
Choose a base branch
from
+28 −0
Open

Docs: document BigQuery Storage Read API usage in Python #37542

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions website/www/site/content/en/documentation/io/built-in/google-bigquery.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,34 @@ a BigQuery table using the Beam SDK, apply a `Read` transform on a `BigQuerySour
{{< /paragraph >}}

### Reading from a table
{{< paragraph class="language-py" >}}
Apache Beam supports reading from BigQuery using the BigQuery Storage Read API
by setting the <code>method</code> parameter to <code>DIRECT_READ</code>.
This method is recommended for large-scale reads because it provides
better performance and parallelism.
{{< /paragraph >}}

### Reading using BigQuery Storage Read API


{{< highlight py >}}
import apache_beam as beam

with beam.Pipeline() as p:
rows = (
p
| beam.io.ReadFromBigQuery(
table="project:dataset.table",
method=beam.io.ReadFromBigQuery.Method.DIRECT_READ
)
)
{{< /highlight >}}

{{< paragraph class="language-py" >}}
***Note:*** The BigQuery Storage Read API requires additional permissions
such as <code>bigquery.readsessions.create</code>.
{{< /paragraph >}}


{{< paragraph class="language-java" >}}
To read an entire BigQuery table, use the `from` method with a BigQuery table
Expand Down