Skip to content

Fix BigQuery Storage Write API stream count for bounded writes#38776

Open
Akshatsharma2205 wants to merge 3 commits into
apache:masterfrom
Akshatsharma2205:fix-bigquery-num-storage-api-streams-bounded
Open

Fix BigQuery Storage Write API stream count for bounded writes#38776
Akshatsharma2205 wants to merge 3 commits into
apache:masterfrom
Akshatsharma2205:fix-bigquery-num-storage-api-streams-bounded

Conversation

@Akshatsharma2205
Copy link
Copy Markdown

Summary

  • Apply configured Storage Write API stream counts to both bounded and unbounded BigQuery writes.
  • Keep triggering frequency and auto-sharding configuration limited to unbounded writes.
  • Update Java, Python, and website documentation to remove the streaming-only limitation for fixed stream counts.

Fixes #38770

Validation

  • Ran git diff --check successfully.
  • Attempted ./gradlew :sdks:java:io:google-cloud-platform:compileJava locally, but the build did not reach Java compilation because this was prepared from a sparse checkout missing Beam build plugin infrastructure.

Key Gradle error:

Plugin [id: 'org.apache.beam.module'] was not found

Java compilation did not start.


Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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 expands the functionality of the BigQuery Storage Write API by allowing the number of write streams to be configured for bounded (batch) writes, in addition to the existing support for unbounded (streaming) writes. The changes ensure that stream count configurations are applied consistently across different pipeline types while maintaining existing constraints on triggering frequency and auto-sharding for streaming data.

Highlights

  • Storage Write API Stream Configuration: Enabled the use of configured Storage Write API stream counts for both bounded and unbounded BigQuery writes.
  • Documentation Updates: Updated Java, Python, and website documentation to clarify that fixed stream counts are now supported for both batch and streaming pipelines.
New Features

🧠 You can now enable Memory (public preview) 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.

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 the 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 counterproductive. 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.

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.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request enables the use of fixed stream counts (numStreams) for both batch (bounded) and streaming (unbounded) pipelines in the BigQuery Storage Write API, updating the Java and Python SDKs as well as the documentation. The review feedback suggests validating that numStreams is non-negative to prevent silent configuration errors, and simplifying the conditional check once validation is in place.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 2, 2026

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@Akshatsharma2205
Copy link
Copy Markdown
Author

The failing/cancelled checks appear unrelated to this PR. I checked the visible annotations and did not see failures mentioning the changed BigQuery files or docs. Several failures are in Python ML/anomaly/RAG tests or CI timeouts.

Could the failed/cancelled checks be rerun when convenient?

@stankiewicz
Copy link
Copy Markdown
Contributor

thanks for looking into this bug

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 3, 2026

Assigning reviewers:

R: @jrmccluskey for label python.
R: @chamikaramj for label java.
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).

@stankiewicz
Copy link
Copy Markdown
Contributor

/gemini review

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request enables using fixed stream counts (numStreams) for both batch and streaming pipelines in the BigQuery Storage Write API. It moves the numStreams configuration logic outside of the unbounded-only check, adds validation to ensure numStreams is non-negative, and updates the corresponding documentation and Python SDK docstrings. Feedback on the changes suggests adding a validation check to ensure numStreams can only be set to 0 if autoSharding is enabled, preventing configurations where 0 streams are silently ignored.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment on lines +104 to +109
if (numStreams != null) {
checkArgument(
numStreams >= 0,
invalidConfigMessage + "numStreams must be non-negative, but was: %s",
numStreams);
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

If numStreams is explicitly set to 0 but autoSharding is not enabled (or is false), the configuration is accepted but numStreams is silently ignored in BigQueryStorageWriteApiSchemaTransformProvider (since it only applies numStreams if it is > 0). To prevent confusing behavior where a user configures 0 streams expecting that to be applied, we should validate that numStreams can only be 0 if autoSharding is enabled.

    if (numStreams != null) {
      checkArgument(
          numStreams >= 0,
          invalidConfigMessage + "numStreams must be non-negative, but was: %s",
          numStreams);
      if (numStreams == 0) {
        checkArgument(
            autoSharding != null && autoSharding,
            invalidConfigMessage + "numStreams can only be 0 if autoSharding is enabled.");
      }
    }

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion i looked into the existing BigQueryIO semantics and i think this validation would be broader than the scope of this PR.

numStorageWriteApiStreams currently uses 0 as the default/unset sentinel in BigQueryIO, and withNumStorageWriteApiStreams(0) is documented as valid behavior: for streaming it lets the runner determine sharding, and for batch it avoids inserting a redistribute and keeps the existing pipeline parallelism.

Because autoSharding is only applicable to unbounded input, requiring numStreams == 0 to also have autoSharding == true would reject or complicate valid/default batch behavior and would be a behavior change beyond this PR’s narrow goal of allowing positive fixed stream counts for bounded Storage Write API writes.

Given that Id prefer not to add this validation unless a reviewer wants to intentionally change the accepted schema transform semantics for explicit numStreams: 0.

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.

[Bug]: Fix num_storage_api_streams for batch

2 participants