Repository navigation
docs(bigquery): document BigQuery interface scope, lifecycle, and thread safety - #15117
Merged
lqiu96 merged 1 commit intoNov 20, 2026
Merged
Conversation
…ead safety Update com.google.cloud.bigquery.BigQuery class Javadoc to: - Summarize the synchronous operations provided by the interface (resources, queries, jobs, and data ingestion). - Document singleton reuse across threads, calling close() on shutdown to release cached background resources (such as Storage Read API clients), and non-thread-safe stateful helpers (Connection and TableDataWriteChannel). - Update the legacy cloud.google.com/bigquery/what-is-bigquery link to https://docs.cloud.google.com/bigquery/docs/introduction. Verified with fmt:check, checkstyle:check@checkstyle, test-compile, and javadoc -Xdoclint:syntax,html,reference.
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the Javadoc for the BigQuery interface to provide detailed documentation on its synchronous operations, thread-safety, resource management, and usage guidelines, as well as updating the reference link. There are no review comments, and I have no feedback to provide.
jinseopkim0
approved these changes
Nov 20, 2026
lqiu96
added a commit
that referenced
this pull request
Nov 21, 2026
Updates 157 malformed, legacy, and broken-anchor documentation URLs across 33 files in `java-bigquery` (Javadoc and comment-only, no behavioral changes). ### Summary of changes - Fix malformed `hhttps://` URL in `ExternalTableDefinition.java`. - Replace pre-`/docs/` `cloud.google.com/bigquery/...` links (which no longer resolve to canonical documentation pages or drop section anchors) with canonical `https://docs.cloud.google.com/bigquery/...` destinations and exact section anchors (for example, `quotas#query_jobs`, `sessions#create-session`, `adding-labels#adding_dataset_labels`, and `biglake-intro#metadata_caching_for_performance`). - Update legacy `/docs/reference/v2/...` URLs and broken camelCase anchors to `/docs/reference/rest/v2/...` with live REST schema, field, and enum anchors (including pointing `JobInfo` and `BigQuery.JobField` to `/rest/v2/Job`, `LoadConfiguration.setFormatOptions` to `Job#JobConfigurationLoad.FIELDS.source_format`, `ExternalTableDefinition` and `CopyJobConfiguration` to exact `.FIELDS.*` anchors, `RoutineInfo` to `#routinetype` and `#datagovernancetype`, and `BigQuery.TableMetadataView`'s link label to `TableMetadataView`). - Fix wrong-topic links for `TableDefinition.Type.MATERIALIZED_VIEW` (`materialized-views-intro`), `ModelTableDefinition`, and `TableDefinition.Type.MODEL` (`bqml-introduction`). - Replace the legacy `developers.google.com` Discovery Javadoc link in `BigQueryDryRunResult.java` with the canonical REST `Job#JobStatistics2.FIELDS.undeclared_query_parameters` anchor. - Update broken `cloud.google.com/bigquery/pricing#storage` and `#long-term-storage` anchors to `#storage-pricing`. - Migrate remaining `cloud.google.com/bigquery/docs/...` and `cloud.google.com/iam/docs/...` links to `docs.cloud.google.com`. Note: Four lines currently touched by open PRs #15117 and #15118 are skipped here to avoid merge conflicts (`DatasetInfo.java:41` will be updated in a follow-up after #15118 merges). Historical GitHub issue comments are preserved. ### Verification - Every unique target URL (71/71) verified live with HTTP 200, 0 redirects, and matching HTML `id=` anchors where fragments are present - `mvn -pl java-bigquery/google-cloud-bigquery com.spotify.fmt:fmt-maven-plugin:check -Dlint checkstyle:check@checkstyle test-compile` (0 Checkstyle violations) - `javadoc -Xdoclint:syntax,html,reference` on all 33 modified files (0 warnings/errors)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update
com.google.cloud.bigquery.BigQueryinterface Javadoc to concisely document the interface itself (modeled onSpannerandStorageconventions).Summary of Changes
BigQuery(managingDataset,Table,Model, andRoutineresources, running SQL queries, submitting and monitoring asynchronousJobs, and ingesting data viawriterandinsertAll).BigQueryOptions#getService(), callingclose()on shutdown to release cached background resources (such as Storage Read API clients used for query streaming), and stateful non-thread-safe helpers (ConnectionandTableDataWriteChannel).https://cloud.google.com/bigquery/what-is-bigquery@seelink tohttps://docs.cloud.google.com/bigquery/docs/introduction.Verification
fmt:check,checkstyle:check@checkstyle,test-compile, andjavadoc -Xdoclint:syntax,html,referenceonjava-bigquery/google-cloud-bigquery.