Skip to content
This repository was archived by the owner on Mar 5, 2026. It is now read-only.

Commit fb8acf1

Browse files
gcf-owl-bot[bot]steffnayBenjamin E. CoeSurferJeffAtGoogle
authored
feat: Deprecate format specific row_count field in Read API (#249)
* fix!: remove bigquery.readonly auth scope PiperOrigin-RevId: 429331987 Source-Link: googleapis/googleapis@4b2bd26 Source-Link: googleapis/googleapis-gen@fa17f03 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZmExN2YwM2I1YWU5NjMxNmNkMDJmMjk5N2YyZmQxMTk2ZTAzNGU1ZSJ9 * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs(samples): include metadata file, add exclusions for samples to handwritten libraries PiperOrigin-RevId: 429395631 Source-Link: googleapis/googleapis@84594b3 Source-Link: googleapis/googleapis-gen@ed74f97 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWQ3NGY5NzBmZDgyOTE0ODc0ZTZiMjdiMDQ3NjNjZmE2NmJhZmU5YiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: add trace_id for Read API PiperOrigin-RevId: 429809867 Source-Link: googleapis/googleapis@6052603 Source-Link: googleapis/googleapis-gen@840dd14 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODQwZGQxNGM5MWEwZWM2NmQ5YmQxYTAyOGQwMWI1ZmQwMjljYTAyZSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs: improve documentation for write client feat: update default timeout/retry information feat: update parent annotation for BatchCommitWriteStreamsRequest feat: expose additional StorageError enum values PiperOrigin-RevId: 431973595 Source-Link: googleapis/googleapis@25d691b Source-Link: googleapis/googleapis-gen@0ca2187 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMGNhMjE4NzlhZTMxMzZhMmQ3MWZhODI0YjQ5ZGZhZjhhMGFlMGYyZSJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * chore: update v2.14.1 gapic-generator-typescript Committer: @summer-ji-eng PiperOrigin-RevId: 433031262 Source-Link: googleapis/googleapis@2a55d13 Source-Link: googleapis/googleapis-gen@2fce389 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMmZjZTM4OTNhZTlkYTQ3NzYzZTA4NzJjNGEzYTg3ZDlmZjc4NzcxZiJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * chore: update v2.14.2 gapic-generator-typescript Committer: @summer-ji-eng PiperOrigin-RevId: 434859890 Source-Link: googleapis/googleapis@bc2432d Source-Link: googleapis/googleapis-gen@930b673 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOTMwYjY3MzEwM2U5MjUyM2Y4Y2ZlZDM4ZGVjZDdkM2FmYWU4ZWJlNyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * feat: Deprecate format specific `row_count` field in Read API PiperOrigin-RevId: 438434001 Source-Link: googleapis/googleapis@727f08b Source-Link: googleapis/googleapis-gen@2d62ab0 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMmQ2MmFiMGQzZDY1MGI3YWJhNGVjNWU1YTk2ZGQ4Y2RiYWU4OWZiNyJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Steffany Brown <[email protected]> Co-authored-by: Benjamin E. Coe <[email protected]> Co-authored-by: Jeffrey Rennie <[email protected]>
1 parent 5543660 commit fb8acf1

33 files changed

Lines changed: 1239 additions & 81 deletions

‎linkinator.config.json‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,14 @@
33
"skip": [
44
"https://codecov.io/gh/googleapis/",
55
"www.googleapis.com",
6-
"img.shields.io"
6+
"img.shields.io",
7+
"https://console.cloud.google.com/cloudshell",
8+
"https://support.google.com"
79
],
810
"silent": true,
9-
"concurrency": 5
11+
"concurrency": 5,
12+
"retry": true,
13+
"retryErrors": true,
14+
"retryErrorsCount": 5,
15+
"retryErrorsJitter": 3000
1016
}

‎protos/google/cloud/bigquery/storage/v1/arrow.proto‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2021 Google LLC
1+
// Copyright 2022 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -39,8 +39,9 @@ message ArrowRecordBatch {
3939
// IPC-serialized Arrow RecordBatch.
4040
bytes serialized_record_batch = 1;
4141

42-
// The count of rows in `serialized_record_batch`.
43-
int64 row_count = 2;
42+
// [Deprecated] The count of rows in `serialized_record_batch`.
43+
// Please use the format-independent ReadRowsResponse.row_count instead.
44+
int64 row_count = 2 [deprecated = true];
4445
}
4546

4647
// Contains options specific to Arrow Serialization.

‎protos/google/cloud/bigquery/storage/v1/avro.proto‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2021 Google LLC
1+
// Copyright 2022 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -35,6 +35,7 @@ message AvroRows {
3535
// Binary serialized rows in a block.
3636
bytes serialized_binary_rows = 1;
3737

38-
// The count of rows in the returning block.
39-
int64 row_count = 2;
38+
// [Deprecated] The count of rows in the returning block.
39+
// Please use the format-independent ReadRowsResponse.row_count instead.
40+
int64 row_count = 2 [deprecated = true];
4041
}

‎protos/google/cloud/bigquery/storage/v1/protobuf.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2021 Google LLC
1+
// Copyright 2022 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

‎protos/google/cloud/bigquery/storage/v1/storage.proto‎

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2021 Google LLC
1+
// Copyright 2022 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -47,7 +47,6 @@ service BigQueryRead {
4747
option (google.api.default_host) = "bigquerystorage.googleapis.com";
4848
option (google.api.oauth_scopes) =
4949
"https://www.googleapis.com/auth/bigquery,"
50-
"https://www.googleapis.com/auth/bigquery.readonly,"
5150
"https://www.googleapis.com/auth/cloud-platform";
5251

5352
// Creates a new read session. A read session divides the contents of a
@@ -168,6 +167,13 @@ service BigQueryWrite {
168167
// * For PENDING streams, data is not made visible until the stream itself is
169168
// finalized (via the `FinalizeWriteStream` rpc), and the stream is explicitly
170169
// committed via the `BatchCommitWriteStreams` rpc.
170+
//
171+
// Note: For users coding against the gRPC api directly, it may be
172+
// necessary to supply the x-goog-request-params system parameter
173+
// with `write_stream=<full_write_stream_name>`.
174+
//
175+
// More information about system parameters:
176+
// https://cloud.google.com/apis/docs/system-parameters
171177
rpc AppendRows(stream AppendRowsRequest) returns (stream AppendRowsResponse) {
172178
option (google.api.http) = {
173179
post: "/v1/{write_stream=projects/*/datasets/*/tables/*/streams/*}"
@@ -409,10 +415,12 @@ message AppendRowsRequest {
409415
// request.
410416
//
411417
// For explicitly created write streams, the format is:
412-
// `projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}`
418+
//
419+
// * `projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}`
413420
//
414421
// For the special default stream, the format is:
415-
// `projects/{project}/datasets/{dataset}/tables/{table}/_default`.
422+
//
423+
// * `projects/{project}/datasets/{dataset}/tables/{table}/streams/_default`.
416424
string write_stream = 1 [
417425
(google.api.field_behavior) = REQUIRED,
418426
(google.api.resource_reference) = {
@@ -499,7 +507,10 @@ message BatchCommitWriteStreamsRequest {
499507
// Required. Parent table that all the streams should belong to, in the form of
500508
// `projects/{project}/datasets/{dataset}/tables/{table}`.
501509
string parent = 1 [
502-
(google.api.field_behavior) = REQUIRED
510+
(google.api.field_behavior) = REQUIRED,
511+
(google.api.resource_reference) = {
512+
type: "bigquery.googleapis.com/Table"
513+
}
503514
];
504515

505516
// Required. The group of streams that will be committed atomically.
@@ -594,6 +605,12 @@ message StorageError {
594605
// There is a schema mismatch and it is caused by user schema has extra
595606
// field than bigquery schema.
596607
SCHEMA_MISMATCH_EXTRA_FIELDS = 7;
608+
609+
// Offset already exists.
610+
OFFSET_ALREADY_EXISTS = 8;
611+
612+
// Offset out of range.
613+
OFFSET_OUT_OF_RANGE = 9;
597614
}
598615

599616
// BigQuery Storage specific error code.

‎protos/google/cloud/bigquery/storage/v1/stream.proto‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2021 Google LLC
1+
// Copyright 2022 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -132,6 +132,14 @@ message ReadSession {
132132
// all streams are completely consumed. This estimate is based on
133133
// metadata from the table which might be incomplete or stale.
134134
int64 estimated_total_bytes_scanned = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
135+
136+
// Optional. ID set by client to annotate a session identity. This does not need
137+
// to be strictly unique, but instead the same ID should be used to group
138+
// logically connected sessions (e.g. All using the same ID for all sessions
139+
// needed to complete a Spark SQL query is reasonable).
140+
//
141+
// Maximum length is 256 bytes.
142+
string trace_id = 13 [(google.api.field_behavior) = OPTIONAL];
135143
}
136144

137145
// Information about a single stream that gets data out of the storage system.

‎protos/google/cloud/bigquery/storage/v1/table.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2021 Google LLC
1+
// Copyright 2022 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.

‎protos/google/cloud/bigquery/storage/v1beta1/storage.proto‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ service BigQueryStorage {
3737
option (google.api.default_host) = "bigquerystorage.googleapis.com";
3838
option (google.api.oauth_scopes) =
3939
"https://www.googleapis.com/auth/bigquery,"
40-
"https://www.googleapis.com/auth/bigquery.readonly,"
4140
"https://www.googleapis.com/auth/cloud-platform";
4241

4342
// Creates a new read session. A read session divides the contents of a

‎protos/protos.d.ts‎

Lines changed: 9 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎protos/protos.js‎

Lines changed: 36 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)