Streaming read for BigQuery

[stankiewicz]

MVP for streaming read using storage read API:

• adds BigQuery descriptor to define what has to be read dynamically - query or table
• BigQuery transform that allow reading in parallel whole table in multiple storage read streams using storage read api or using a query that is materialized into temporary dataset
• transform have set of parameters that is similar to other BQ read transforms like error handler
• support for table row or pojo (with parser and coder)

fixes: #35711

not supported yet:

• schemas and external transform

---

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)

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]

Summary of Changes

Hello @stankiewicz, I'm Gemini Code Assist¹! 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 lays the groundwork for streaming data ingestion from BigQuery by introducing a dynamic read mechanism. It provides a foundational implementation for reading entire tables in parallel using the BigQuery Storage Read API, along with a concrete example to illustrate its usage. The changes are presented as a Minimum Viable Product (MVP) to gather feedback and guide further development towards robust streaming BigQuery integration.

Highlights

• Dynamic BigQuery Read Descriptor: Introduced a new BigQueryDynamicReadDescriptor to define BigQuery sources for dynamic reading, allowing for flexible specification of tables or queries.
• Streaming BigQuery Transform: Added a BigQueryIO.DynamicRead PTransform that enables reading entire BigQuery tables in parallel using multiple storage read streams via the BigQuery Storage Read API. This is an initial MVP for discussion.
• New Example Pipeline: Included a new example, BigQueryStreamingTornadoes.java, which demonstrates how to periodically read public weather data from BigQuery using the new dynamic read capabilities, count tornadoes, and write the results back to BigQuery.

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]

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

[github-actions]

Assigning reviewers:

R: @Abacn for label java.

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]

/gemini review

[gemini-code-assist]

Code Review

This pull request introduces a valuable new feature for streaming reads from BigQuery using the storage read API. The changes include a new BigQueryDynamicReadDescriptor, a readDynamically transform, a comprehensive example, and several new tests. The overall implementation is solid, but I have identified a few areas for improvement to enhance correctness, maintainability, and test robustness. My review includes suggestions to prevent a potential NullPointerException, fix an equals/hashCode contract violation, remove duplicated and dead code, and eliminate a hardcoded project ID in an integration test.

[stankiewicz]

R: @damccorm

[github-actions]

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

[stankiewicz]

IO direct is ooming on unrelated tests but I think I need to catch this oom.

[stankiewicz]

Run Java PreCommit

[damccorm]

Thanks - just had one nit, but overall this LGTM

[damccorm]

Nit: For consistency, can we call this getUseLegacySql

beam/sdks/java/io/google-cloud-platform/src/main/java/org/apache/beam/sdk/io/gcp/bigquery/BigQueryIO.java

Line 973 in 6d24c3d

abstract Builder<T> setUseLegacySql(Boolean useLegacySql);

[codecov]

Codecov Report

❌ Patch coverage is 88.03419% with 14 lines in your changes missing coverage. Please review.
✅ Project coverage is 56.60%. Comparing base (ef04862) to head (74304be).
⚠️ Report is 735 commits behind head on master.

Files with missing lines	Patch %	Lines
...rg/apache/beam/sdk/io/gcp/bigquery/BigQueryIO.java	93.87%	5 Missing and 1 partial ⚠️
...k/io/gcp/bigquery/BigQueryStorageStreamSource.java	40.00%	1 Missing and 5 partials ⚠️
...io/gcp/bigquery/BigQueryDynamicReadDescriptor.java	77.77%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##             master   #36668      +/-   ##
============================================
+ Coverage     56.53%   56.60%   +0.06%     
- Complexity     3381     3455      +74     
============================================
  Files          1203     1204       +1     
  Lines        183894   184593     +699     
  Branches       3490     3586      +96     
============================================
+ Hits         103968   104481     +513     
- Misses        76599    76747     +148     
- Partials       3327     3365      +38     

Flag	Coverage Δ
java	70.56% <88.03%> (+0.06%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Abacn]

The newly added integration tests testBigQueryDynamicRead1MErrorHandlingArrow and testBigQueryDynamicRead1MErrorHandlingAvro are failing on Dataflow: #30730 #30729

Shall we skip it as other BQIO read tests in

beam/runners/google-cloud-dataflow-java/build.gradle

Line 607 in 1b89fcf

exclude '**/BigQueryIOReadIT.class'

beam/runners/google-cloud-dataflow-java/build.gradle

Line 660 in 1b89fcf

exclude '**/BigQueryIOStorageReadTableRowIT.class'