Skip to content

Commit 199949b

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: publish the RequestStats proto (#676)
* feat: publish the RequestStats proto PiperOrigin-RevId: 476399682 Source-Link: googleapis/googleapis@0c4e682 Source-Link: googleapis/googleapis-gen@ff87f69 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZmY4N2Y2OWFhZDFmMmZmMDY3NzJmOTE3ZWVjYmVhNjQ5Nzk3ZDlkNSJ9 * 🦉 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>
1 parent 1175da5 commit 199949b

File tree

8 files changed

+285
-14
lines changed

8 files changed

+285
-14
lines changed

‎google/cloud/bigtable_v2/__init__.py‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,16 @@
4343
from .types.data import RowSet
4444
from .types.data import TimestampRange
4545
from .types.data import ValueRange
46+
from .types.request_stats import AllReadStats
47+
from .types.request_stats import ReadEfficiencyStats
48+
from .types.request_stats import ReadIteratorStats
49+
from .types.request_stats import RequestLatencyStats
50+
from .types.request_stats import RequestStats
4651
from .types.response_params import ResponseParams
4752

4853
__all__ = (
4954
"BigtableAsyncClient",
55+
"AllReadStats",
5056
"BigtableClient",
5157
"Cell",
5258
"CheckAndMutateRowRequest",
@@ -61,11 +67,15 @@
6167
"Mutation",
6268
"PingAndWarmRequest",
6369
"PingAndWarmResponse",
70+
"ReadEfficiencyStats",
71+
"ReadIteratorStats",
6472
"ReadModifyWriteRowRequest",
6573
"ReadModifyWriteRowResponse",
6674
"ReadModifyWriteRule",
6775
"ReadRowsRequest",
6876
"ReadRowsResponse",
77+
"RequestLatencyStats",
78+
"RequestStats",
6979
"ResponseParams",
7080
"Row",
7181
"RowFilter",

‎google/cloud/bigtable_v2/services/bigtable/async_client.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@
4343

4444
from google.cloud.bigtable_v2.types import bigtable
4545
from google.cloud.bigtable_v2.types import data
46+
from google.cloud.bigtable_v2.types import request_stats
4647
from .transports.base import BigtableTransport, DEFAULT_CLIENT_INFO
4748
from .transports.grpc_asyncio import BigtableGrpcAsyncIOTransport
4849
from .client import BigtableClient
@@ -238,10 +239,8 @@ def read_rows(
238239
on the ``request`` instance; if ``request`` is provided, this
239240
should not be set.
240241
app_profile_id (:class:`str`):
241-
This value specifies routing for
242-
replication. If not specified, the
243-
"default" application profile will be
244-
used.
242+
This value specifies routing for replication. This API
243+
only accepts the empty value of app_profile_id.
245244
246245
This corresponds to the ``app_profile_id`` field
247246
on the ``request`` instance; if ``request`` is provided, this

‎google/cloud/bigtable_v2/services/bigtable/client.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636

3737
from google.cloud.bigtable_v2.types import bigtable
3838
from google.cloud.bigtable_v2.types import data
39+
from google.cloud.bigtable_v2.types import request_stats
3940
from .transports.base import BigtableTransport, DEFAULT_CLIENT_INFO
4041
from .transports.grpc import BigtableGrpcTransport
4142
from .transports.grpc_asyncio import BigtableGrpcAsyncIOTransport
@@ -474,10 +475,8 @@ def read_rows(
474475
on the ``request`` instance; if ``request`` is provided, this
475476
should not be set.
476477
app_profile_id (str):
477-
This value specifies routing for
478-
replication. If not specified, the
479-
"default" application profile will be
480-
used.
478+
This value specifies routing for replication. This API
479+
only accepts the empty value of app_profile_id.
481480
482481
This corresponds to the ``app_profile_id`` field
483482
on the ``request`` instance; if ``request`` is provided, this

‎google/cloud/bigtable_v2/types/__init__.py‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,13 @@
4343
TimestampRange,
4444
ValueRange,
4545
)
46+
from .request_stats import (
47+
AllReadStats,
48+
ReadEfficiencyStats,
49+
ReadIteratorStats,
50+
RequestLatencyStats,
51+
RequestStats,
52+
)
4653
from .response_params import (
4754
ResponseParams,
4855
)
@@ -74,5 +81,10 @@
7481
"RowSet",
7582
"TimestampRange",
7683
"ValueRange",
84+
"AllReadStats",
85+
"ReadEfficiencyStats",
86+
"ReadIteratorStats",
87+
"RequestLatencyStats",
88+
"RequestStats",
7789
"ResponseParams",
7890
)

‎google/cloud/bigtable_v2/types/bigtable.py‎

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
import proto # type: ignore
1717

1818
from google.cloud.bigtable_v2.types import data
19+
from google.cloud.bigtable_v2.types import request_stats as gb_request_stats
1920
from google.protobuf import wrappers_pb2 # type: ignore
2021
from google.rpc import status_pb2 # type: ignore
2122

@@ -50,9 +51,8 @@ class ReadRowsRequest(proto.Message):
5051
Values are of the form
5152
``projects/<project>/instances/<instance>/tables/<table>``.
5253
app_profile_id (str):
53-
This value specifies routing for replication.
54-
If not specified, the "default" application
55-
profile will be used.
54+
This value specifies routing for replication. This API only
55+
accepts the empty value of app_profile_id.
5656
rows (google.cloud.bigtable_v2.types.RowSet):
5757
The row keys and/or ranges to read
5858
sequentially. If not specified, reads from all
@@ -65,8 +65,21 @@ class ReadRowsRequest(proto.Message):
6565
The read will stop after committing to N
6666
rows' worth of results. The default (zero) is to
6767
return all results.
68+
request_stats_view (google.cloud.bigtable_v2.types.ReadRowsRequest.RequestStatsView):
69+
The view into RequestStats, as described
70+
above.
6871
"""
6972

73+
class RequestStatsView(proto.Enum):
74+
r"""The desired view into RequestStats that should be returned in
75+
the response.
76+
See also: RequestStats message.
77+
"""
78+
REQUEST_STATS_VIEW_UNSPECIFIED = 0
79+
REQUEST_STATS_NONE = 1
80+
REQUEST_STATS_EFFICIENCY = 2
81+
REQUEST_STATS_FULL = 3
82+
7083
table_name = proto.Field(
7184
proto.STRING,
7285
number=1,
@@ -89,6 +102,11 @@ class ReadRowsRequest(proto.Message):
89102
proto.INT64,
90103
number=4,
91104
)
105+
request_stats_view = proto.Field(
106+
proto.ENUM,
107+
number=6,
108+
enum=RequestStatsView,
109+
)
92110

93111

94112
class ReadRowsResponse(proto.Message):
@@ -109,6 +127,28 @@ class ReadRowsResponse(proto.Message):
109127
that was filtered out since the last committed
110128
row key, allowing the client to skip that work
111129
on a retry.
130+
request_stats (google.cloud.bigtable_v2.types.RequestStats):
131+
If requested, provide enhanced query performance statistics.
132+
The semantics dictate:
133+
134+
- request_stats is empty on every (streamed) response,
135+
except
136+
- request_stats has non-empty information after all chunks
137+
have been streamed, where the ReadRowsResponse message
138+
only contains request_stats.
139+
140+
- For example, if a read request would have returned an
141+
empty response instead a single ReadRowsResponse is
142+
streamed with empty chunks and request_stats filled.
143+
144+
Visually, response messages will stream as follows: ... ->
145+
{chunks: [...]} -> {chunks: [], request_stats: {...}}
146+
\_\ **/ \_**\ \__________/ Primary response Trailer of
147+
RequestStats info
148+
149+
Or if the read did not return any values: {chunks: [],
150+
request_stats: {...}} \________________________________/
151+
Trailer of RequestStats info
112152
"""
113153

114154
class CellChunk(proto.Message):
@@ -232,6 +272,11 @@ class CellChunk(proto.Message):
232272
proto.BYTES,
233273
number=2,
234274
)
275+
request_stats = proto.Field(
276+
proto.MESSAGE,
277+
number=3,
278+
message=gb_request_stats.RequestStats,
279+
)
235280

236281

237282
class SampleRowKeysRequest(proto.Message):
@@ -370,8 +415,8 @@ class Entry(proto.Message):
370415
Required. Changes to be atomically applied to
371416
the specified row. Mutations are applied in
372417
order, meaning that earlier mutations can be
373-
masked by later ones.
374-
You must specify at least one mutation.
418+
masked by later ones. You must specify at least
419+
one mutation.
375420
"""
376421

377422
row_key = proto.Field(

0 commit comments

Comments
 (0)