Skip to content

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

Open
Midhat-kazmi wants to merge 1 commit intoapache:masterfrom
Midhat-kazmi:docs-bigquery-read-api
Open

Docs: document BigQuery Storage Read API usage in Python#37542
Midhat-kazmi wants to merge 1 commit intoapache:masterfrom
Midhat-kazmi:docs-bigquery-read-api

Conversation

@Midhat-kazmi
Copy link

Adds documentation and a Python example for using BigQuery Storage Read API
with ReadFromBigQuery (method=DIRECT_READ), including permission notes.

Issue: #27026

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @Midhat-kazmi, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the Apache Beam documentation by integrating a new section that guides Python users on how to effectively utilize the BigQuery Storage Read API. The update aims to improve clarity for large-scale data processing by providing a practical code example and outlining necessary permissions, thereby enabling more efficient and parallel data reads from BigQuery.

Highlights

  • BigQuery Storage Read API Documentation: Added a new documentation section specifically for using the BigQuery Storage Read API with Python in Apache Beam.
  • Python Example for DIRECT_READ: Included a Python code example demonstrating how to use beam.io.ReadFromBigQuery with the method parameter set to DIRECT_READ for improved performance and parallelism.
  • Permission Notes: Provided an important note detailing the additional permissions, such as bigquery.readsessions.create, required for utilizing the BigQuery Storage Read API.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • website/www/site/content/en/documentation/io/built-in/google-bigquery.md
    • Introduced a new paragraph explaining the benefits of using the BigQuery Storage Read API with DIRECT_READ in Python.
    • Added a new subsection titled 'Reading using BigQuery Storage Read API'.
    • Included a Python code block demonstrating the usage of beam.io.ReadFromBigQuery with method=beam.io.ReadFromBigQuery.Method.DIRECT_READ.
    • Appended a note highlighting the bigquery.readsessions.create permission requirement for the BigQuery Storage Read API.
Activity
  • No specific activity (comments, reviews, or progress updates) has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 7, 2026

Assigning reviewers:

R: @damccorm for label website.

Note: If you would like to opt out of this review, comment assign to next reviewer.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants