Skip to content

docs(bigquery-storage): mark ReadRows arrow serialization as beta - #18802

Open
ohmayr wants to merge 2 commits into
mainfrom
docs/bigquery-storage-arrow-serialization-preview
Open

ohmayr wants to merge 2 commits into
mainfrom
docs/bigquery-storage-arrow-serialization-preview

Conversation

@ohmayr

@ohmayr ohmayr commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Before, the arrow_serialization_options parameter of BigQueryReadClient.read_rows() had no launch-stage marker, so it read as generally available. The backend marks the matching ReadRowsRequest field "This feature is not yet available" in storage.proto, and it isn't on the public reference page yet.

  • Marks read_rows()'s arrow_serialization_options as [Beta], and adds the same marker where the ReadRowsStream request_template docstring uses it as an example.
  • [Beta] matches google-cloud-bigquery, which sends this field for query_and_wait(query_results_format="ARROW") and already marks query_results_format and compression_codec as [Beta]. The jobs.query side has the same "not yet available" note in the REST discovery document.
  • Docstrings only, no behavior change.

The backend marks ReadRowsRequest.arrow_serialization_options as not
yet available, but the read_rows() parameter had no preview marker.
Label it [Private Preview], matching google-cloud-bigquery's
timestamp_precision.
@ohmayr
ohmayr requested review from a team as code owners October 21, 2026 22:09
@ohmayr
ohmayr requested review from sycai and removed request for a team October 21, 2026 22:09

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

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.

Code Review

This pull request updates the docstring for the arrow_serialization_options parameter in the read_rows method of the BigQuery Storage client to indicate that it is in Private Preview. There are no review comments, and I have no feedback to provide.

@ohmayr ohmayr added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 21, 2026
@ohmayr
ohmayr requested review from tswast and removed request for sycai October 21, 2026 22:18
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 21, 2026
Use [Beta] instead of [Private Preview], matching google-cloud-bigquery,
which sends this field for ARROW query results and marks
query_results_format and compression_codec as [Beta]. Also mark the
field where the ReadRowsStream request_template docstring uses it as an
example.
@ohmayr ohmayr changed the title docs(bigquery-storage): mark ReadRows arrow serialization as preview docs(bigquery-storage): mark ReadRows arrow serialization as beta Oct 21, 2026

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants