/
grpc_asyncio.py
769 lines (685 loc) · 33.6 KB
/
grpc_asyncio.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
# -*- coding: utf-8 -*-
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import warnings
from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union
from google.api_core import gapic_v1 # type: ignore
from google.api_core import grpc_helpers_async # type: ignore
from google.auth import credentials as ga_credentials # type: ignore
from google.auth.transport.grpc import SslCredentials # type: ignore
import packaging.version
import grpc # type: ignore
from grpc.experimental import aio # type: ignore
from google.cloud.spanner_v1.types import commit_response
from google.cloud.spanner_v1.types import result_set
from google.cloud.spanner_v1.types import spanner
from google.cloud.spanner_v1.types import transaction
from google.protobuf import empty_pb2 # type: ignore
from .base import SpannerTransport, DEFAULT_CLIENT_INFO
from .grpc import SpannerGrpcTransport
class SpannerGrpcAsyncIOTransport(SpannerTransport):
"""gRPC AsyncIO backend transport for Spanner.
Cloud Spanner API
The Cloud Spanner API can be used to manage sessions and execute
transactions on data stored in Cloud Spanner databases.
This class defines the same methods as the primary client, so the
primary client can load the underlying transport implementation
and call it.
It sends protocol buffers over the wire using gRPC (which is built on
top of HTTP/2); the ``grpcio`` package must be installed.
"""
_grpc_channel: aio.Channel
_stubs: Dict[str, Callable] = {}
@classmethod
def create_channel(
cls,
host: str = "spanner.googleapis.com",
credentials: ga_credentials.Credentials = None,
credentials_file: Optional[str] = None,
scopes: Optional[Sequence[str]] = None,
quota_project_id: Optional[str] = None,
**kwargs,
) -> aio.Channel:
"""Create and return a gRPC AsyncIO channel object.
Args:
host (Optional[str]): The host for the channel to use.
credentials (Optional[~.Credentials]): The
authorization credentials to attach to requests. These
credentials identify this application to the service. If
none are specified, the client will attempt to ascertain
the credentials from the environment.
credentials_file (Optional[str]): A file with credentials that can
be loaded with :func:`google.auth.load_credentials_from_file`.
This argument is ignored if ``channel`` is provided.
scopes (Optional[Sequence[str]]): A optional list of scopes needed for this
service. These are only used when credentials are not specified and
are passed to :func:`google.auth.default`.
quota_project_id (Optional[str]): An optional project to use for billing
and quota.
kwargs (Optional[dict]): Keyword arguments, which are passed to the
channel creation.
Returns:
aio.Channel: A gRPC AsyncIO channel object.
"""
return grpc_helpers_async.create_channel(
host,
credentials=credentials,
credentials_file=credentials_file,
quota_project_id=quota_project_id,
default_scopes=cls.AUTH_SCOPES,
scopes=scopes,
default_host=cls.DEFAULT_HOST,
**kwargs,
)
def __init__(
self,
*,
host: str = "spanner.googleapis.com",
credentials: ga_credentials.Credentials = None,
credentials_file: Optional[str] = None,
scopes: Optional[Sequence[str]] = None,
channel: aio.Channel = None,
api_mtls_endpoint: str = None,
client_cert_source: Callable[[], Tuple[bytes, bytes]] = None,
ssl_channel_credentials: grpc.ChannelCredentials = None,
client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None,
quota_project_id=None,
client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO,
always_use_jwt_access: Optional[bool] = False,
) -> None:
"""Instantiate the transport.
Args:
host (Optional[str]):
The hostname to connect to.
credentials (Optional[google.auth.credentials.Credentials]): The
authorization credentials to attach to requests. These
credentials identify the application to the service; if none
are specified, the client will attempt to ascertain the
credentials from the environment.
This argument is ignored if ``channel`` is provided.
credentials_file (Optional[str]): A file with credentials that can
be loaded with :func:`google.auth.load_credentials_from_file`.
This argument is ignored if ``channel`` is provided.
scopes (Optional[Sequence[str]]): A optional list of scopes needed for this
service. These are only used when credentials are not specified and
are passed to :func:`google.auth.default`.
channel (Optional[aio.Channel]): A ``Channel`` instance through
which to make calls.
api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint.
If provided, it overrides the ``host`` argument and tries to create
a mutual TLS channel with client SSL credentials from
``client_cert_source`` or applicatin default SSL credentials.
client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]):
Deprecated. A callback to provide client SSL certificate bytes and
private key bytes, both in PEM format. It is ignored if
``api_mtls_endpoint`` is None.
ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials
for grpc channel. It is ignored if ``channel`` is provided.
client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]):
A callback to provide client certificate bytes and private key bytes,
both in PEM format. It is used to configure mutual TLS channel. It is
ignored if ``channel`` or ``ssl_channel_credentials`` is provided.
quota_project_id (Optional[str]): An optional project to use for billing
and quota.
client_info (google.api_core.gapic_v1.client_info.ClientInfo):
The client info used to send a user-agent string along with
API requests. If ``None``, then default info will be used.
Generally, you only need to set this if you're developing
your own client library.
always_use_jwt_access (Optional[bool]): Whether self signed JWT should
be used for service account credentials.
Raises:
google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport
creation failed for any reason.
google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials``
and ``credentials_file`` are passed.
"""
self._grpc_channel = None
self._ssl_channel_credentials = ssl_channel_credentials
self._stubs: Dict[str, Callable] = {}
if api_mtls_endpoint:
warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning)
if client_cert_source:
warnings.warn("client_cert_source is deprecated", DeprecationWarning)
if channel:
# Ignore credentials if a channel was passed.
credentials = False
# If a channel was explicitly provided, set it.
self._grpc_channel = channel
self._ssl_channel_credentials = None
else:
if api_mtls_endpoint:
host = api_mtls_endpoint
# Create SSL credentials with client_cert_source or application
# default SSL credentials.
if client_cert_source:
cert, key = client_cert_source()
self._ssl_channel_credentials = grpc.ssl_channel_credentials(
certificate_chain=cert, private_key=key
)
else:
self._ssl_channel_credentials = SslCredentials().ssl_credentials
else:
if client_cert_source_for_mtls and not ssl_channel_credentials:
cert, key = client_cert_source_for_mtls()
self._ssl_channel_credentials = grpc.ssl_channel_credentials(
certificate_chain=cert, private_key=key
)
# The base transport sets the host, credentials and scopes
super().__init__(
host=host,
credentials=credentials,
credentials_file=credentials_file,
scopes=scopes,
quota_project_id=quota_project_id,
client_info=client_info,
always_use_jwt_access=always_use_jwt_access,
)
if not self._grpc_channel:
self._grpc_channel = type(self).create_channel(
self._host,
credentials=self._credentials,
credentials_file=credentials_file,
scopes=self._scopes,
ssl_credentials=self._ssl_channel_credentials,
quota_project_id=quota_project_id,
options=[
("grpc.max_send_message_length", -1),
("grpc.max_receive_message_length", -1),
],
)
# Wrap messages. This must be done after self._grpc_channel exists
self._prep_wrapped_messages(client_info)
@property
def grpc_channel(self) -> aio.Channel:
"""Create the channel designed to connect to this service.
This property caches on the instance; repeated calls return
the same channel.
"""
# Return the channel from cache.
return self._grpc_channel
@property
def create_session(
self,
) -> Callable[[spanner.CreateSessionRequest], Awaitable[spanner.Session]]:
r"""Return a callable for the create session method over gRPC.
Creates a new session. A session can be used to perform
transactions that read and/or modify data in a Cloud Spanner
database. Sessions are meant to be reused for many consecutive
transactions.
Sessions can only execute one transaction at a time. To execute
multiple concurrent read-write/write-only transactions, create
multiple sessions. Note that standalone reads and queries use a
transaction internally, and count toward the one transaction
limit.
Active sessions use additional server resources, so it is a good
idea to delete idle and unneeded sessions. Aside from explicit
deletes, Cloud Spanner may delete sessions for which no
operations are sent for more than an hour. If a session is
deleted, requests to it return ``NOT_FOUND``.
Idle sessions can be kept alive by sending a trivial SQL query
periodically, e.g., ``"SELECT 1"``.
Returns:
Callable[[~.CreateSessionRequest],
Awaitable[~.Session]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "create_session" not in self._stubs:
self._stubs["create_session"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/CreateSession",
request_serializer=spanner.CreateSessionRequest.serialize,
response_deserializer=spanner.Session.deserialize,
)
return self._stubs["create_session"]
@property
def batch_create_sessions(
self,
) -> Callable[
[spanner.BatchCreateSessionsRequest],
Awaitable[spanner.BatchCreateSessionsResponse],
]:
r"""Return a callable for the batch create sessions method over gRPC.
Creates multiple new sessions.
This API can be used to initialize a session cache on
the clients. See https://goo.gl/TgSFN2 for best
practices on session cache management.
Returns:
Callable[[~.BatchCreateSessionsRequest],
Awaitable[~.BatchCreateSessionsResponse]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "batch_create_sessions" not in self._stubs:
self._stubs["batch_create_sessions"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/BatchCreateSessions",
request_serializer=spanner.BatchCreateSessionsRequest.serialize,
response_deserializer=spanner.BatchCreateSessionsResponse.deserialize,
)
return self._stubs["batch_create_sessions"]
@property
def get_session(
self,
) -> Callable[[spanner.GetSessionRequest], Awaitable[spanner.Session]]:
r"""Return a callable for the get session method over gRPC.
Gets a session. Returns ``NOT_FOUND`` if the session does not
exist. This is mainly useful for determining whether a session
is still alive.
Returns:
Callable[[~.GetSessionRequest],
Awaitable[~.Session]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "get_session" not in self._stubs:
self._stubs["get_session"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/GetSession",
request_serializer=spanner.GetSessionRequest.serialize,
response_deserializer=spanner.Session.deserialize,
)
return self._stubs["get_session"]
@property
def list_sessions(
self,
) -> Callable[
[spanner.ListSessionsRequest], Awaitable[spanner.ListSessionsResponse]
]:
r"""Return a callable for the list sessions method over gRPC.
Lists all sessions in a given database.
Returns:
Callable[[~.ListSessionsRequest],
Awaitable[~.ListSessionsResponse]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "list_sessions" not in self._stubs:
self._stubs["list_sessions"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/ListSessions",
request_serializer=spanner.ListSessionsRequest.serialize,
response_deserializer=spanner.ListSessionsResponse.deserialize,
)
return self._stubs["list_sessions"]
@property
def delete_session(
self,
) -> Callable[[spanner.DeleteSessionRequest], Awaitable[empty_pb2.Empty]]:
r"""Return a callable for the delete session method over gRPC.
Ends a session, releasing server resources associated
with it. This will asynchronously trigger cancellation
of any operations that are running with this session.
Returns:
Callable[[~.DeleteSessionRequest],
Awaitable[~.Empty]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "delete_session" not in self._stubs:
self._stubs["delete_session"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/DeleteSession",
request_serializer=spanner.DeleteSessionRequest.serialize,
response_deserializer=empty_pb2.Empty.FromString,
)
return self._stubs["delete_session"]
@property
def execute_sql(
self,
) -> Callable[[spanner.ExecuteSqlRequest], Awaitable[result_set.ResultSet]]:
r"""Return a callable for the execute sql method over gRPC.
Executes an SQL statement, returning all results in a single
reply. This method cannot be used to return a result set larger
than 10 MiB; if the query yields more data than that, the query
fails with a ``FAILED_PRECONDITION`` error.
Operations inside read-write transactions might return
``ABORTED``. If this occurs, the application should restart the
transaction from the beginning. See
[Transaction][google.spanner.v1.Transaction] for more details.
Larger result sets can be fetched in streaming fashion by
calling
[ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql]
instead.
Returns:
Callable[[~.ExecuteSqlRequest],
Awaitable[~.ResultSet]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "execute_sql" not in self._stubs:
self._stubs["execute_sql"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/ExecuteSql",
request_serializer=spanner.ExecuteSqlRequest.serialize,
response_deserializer=result_set.ResultSet.deserialize,
)
return self._stubs["execute_sql"]
@property
def execute_streaming_sql(
self,
) -> Callable[[spanner.ExecuteSqlRequest], Awaitable[result_set.PartialResultSet]]:
r"""Return a callable for the execute streaming sql method over gRPC.
Like [ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], except
returns the result set as a stream. Unlike
[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql], there is no
limit on the size of the returned result set. However, no
individual row in the result set can exceed 100 MiB, and no
column value can exceed 10 MiB.
Returns:
Callable[[~.ExecuteSqlRequest],
Awaitable[~.PartialResultSet]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "execute_streaming_sql" not in self._stubs:
self._stubs["execute_streaming_sql"] = self.grpc_channel.unary_stream(
"/google.spanner.v1.Spanner/ExecuteStreamingSql",
request_serializer=spanner.ExecuteSqlRequest.serialize,
response_deserializer=result_set.PartialResultSet.deserialize,
)
return self._stubs["execute_streaming_sql"]
@property
def execute_batch_dml(
self,
) -> Callable[
[spanner.ExecuteBatchDmlRequest], Awaitable[spanner.ExecuteBatchDmlResponse]
]:
r"""Return a callable for the execute batch dml method over gRPC.
Executes a batch of SQL DML statements. This method allows many
statements to be run with lower latency than submitting them
sequentially with
[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql].
Statements are executed in sequential order. A request can
succeed even if a statement fails. The
[ExecuteBatchDmlResponse.status][google.spanner.v1.ExecuteBatchDmlResponse.status]
field in the response provides information about the statement
that failed. Clients must inspect this field to determine
whether an error occurred.
Execution stops after the first failed statement; the remaining
statements are not executed.
Returns:
Callable[[~.ExecuteBatchDmlRequest],
Awaitable[~.ExecuteBatchDmlResponse]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "execute_batch_dml" not in self._stubs:
self._stubs["execute_batch_dml"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/ExecuteBatchDml",
request_serializer=spanner.ExecuteBatchDmlRequest.serialize,
response_deserializer=spanner.ExecuteBatchDmlResponse.deserialize,
)
return self._stubs["execute_batch_dml"]
@property
def read(self) -> Callable[[spanner.ReadRequest], Awaitable[result_set.ResultSet]]:
r"""Return a callable for the read method over gRPC.
Reads rows from the database using key lookups and scans, as a
simple key/value style alternative to
[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql]. This method
cannot be used to return a result set larger than 10 MiB; if the
read matches more data than that, the read fails with a
``FAILED_PRECONDITION`` error.
Reads inside read-write transactions might return ``ABORTED``.
If this occurs, the application should restart the transaction
from the beginning. See
[Transaction][google.spanner.v1.Transaction] for more details.
Larger result sets can be yielded in streaming fashion by
calling [StreamingRead][google.spanner.v1.Spanner.StreamingRead]
instead.
Returns:
Callable[[~.ReadRequest],
Awaitable[~.ResultSet]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "read" not in self._stubs:
self._stubs["read"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/Read",
request_serializer=spanner.ReadRequest.serialize,
response_deserializer=result_set.ResultSet.deserialize,
)
return self._stubs["read"]
@property
def streaming_read(
self,
) -> Callable[[spanner.ReadRequest], Awaitable[result_set.PartialResultSet]]:
r"""Return a callable for the streaming read method over gRPC.
Like [Read][google.spanner.v1.Spanner.Read], except returns the
result set as a stream. Unlike
[Read][google.spanner.v1.Spanner.Read], there is no limit on the
size of the returned result set. However, no individual row in
the result set can exceed 100 MiB, and no column value can
exceed 10 MiB.
Returns:
Callable[[~.ReadRequest],
Awaitable[~.PartialResultSet]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "streaming_read" not in self._stubs:
self._stubs["streaming_read"] = self.grpc_channel.unary_stream(
"/google.spanner.v1.Spanner/StreamingRead",
request_serializer=spanner.ReadRequest.serialize,
response_deserializer=result_set.PartialResultSet.deserialize,
)
return self._stubs["streaming_read"]
@property
def begin_transaction(
self,
) -> Callable[
[spanner.BeginTransactionRequest], Awaitable[transaction.Transaction]
]:
r"""Return a callable for the begin transaction method over gRPC.
Begins a new transaction. This step can often be skipped:
[Read][google.spanner.v1.Spanner.Read],
[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and
[Commit][google.spanner.v1.Spanner.Commit] can begin a new
transaction as a side-effect.
Returns:
Callable[[~.BeginTransactionRequest],
Awaitable[~.Transaction]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "begin_transaction" not in self._stubs:
self._stubs["begin_transaction"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/BeginTransaction",
request_serializer=spanner.BeginTransactionRequest.serialize,
response_deserializer=transaction.Transaction.deserialize,
)
return self._stubs["begin_transaction"]
@property
def commit(
self,
) -> Callable[[spanner.CommitRequest], Awaitable[commit_response.CommitResponse]]:
r"""Return a callable for the commit method over gRPC.
Commits a transaction. The request includes the mutations to be
applied to rows in the database.
``Commit`` might return an ``ABORTED`` error. This can occur at
any time; commonly, the cause is conflicts with concurrent
transactions. However, it can also happen for a variety of other
reasons. If ``Commit`` returns ``ABORTED``, the caller should
re-attempt the transaction from the beginning, re-using the same
session.
On very rare occasions, ``Commit`` might return ``UNKNOWN``.
This can happen, for example, if the client job experiences a 1+
hour networking failure. At that point, Cloud Spanner has lost
track of the transaction outcome and we recommend that you
perform another read from the database to see the state of
things as they are now.
Returns:
Callable[[~.CommitRequest],
Awaitable[~.CommitResponse]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "commit" not in self._stubs:
self._stubs["commit"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/Commit",
request_serializer=spanner.CommitRequest.serialize,
response_deserializer=commit_response.CommitResponse.deserialize,
)
return self._stubs["commit"]
@property
def rollback(
self,
) -> Callable[[spanner.RollbackRequest], Awaitable[empty_pb2.Empty]]:
r"""Return a callable for the rollback method over gRPC.
Rolls back a transaction, releasing any locks it holds. It is a
good idea to call this for any transaction that includes one or
more [Read][google.spanner.v1.Spanner.Read] or
[ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] requests and
ultimately decides not to commit.
``Rollback`` returns ``OK`` if it successfully aborts the
transaction, the transaction was already aborted, or the
transaction is not found. ``Rollback`` never returns
``ABORTED``.
Returns:
Callable[[~.RollbackRequest],
Awaitable[~.Empty]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "rollback" not in self._stubs:
self._stubs["rollback"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/Rollback",
request_serializer=spanner.RollbackRequest.serialize,
response_deserializer=empty_pb2.Empty.FromString,
)
return self._stubs["rollback"]
@property
def partition_query(
self,
) -> Callable[
[spanner.PartitionQueryRequest], Awaitable[spanner.PartitionResponse]
]:
r"""Return a callable for the partition query method over gRPC.
Creates a set of partition tokens that can be used to execute a
query operation in parallel. Each of the returned partition
tokens can be used by
[ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql]
to specify a subset of the query result to read. The same
session and read-only transaction must be used by the
PartitionQueryRequest used to create the partition tokens and
the ExecuteSqlRequests that use the partition tokens.
Partition tokens become invalid when the session used to create
them is deleted, is idle for too long, begins a new transaction,
or becomes too old. When any of these happen, it is not possible
to resume the query, and the whole operation must be restarted
from the beginning.
Returns:
Callable[[~.PartitionQueryRequest],
Awaitable[~.PartitionResponse]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "partition_query" not in self._stubs:
self._stubs["partition_query"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/PartitionQuery",
request_serializer=spanner.PartitionQueryRequest.serialize,
response_deserializer=spanner.PartitionResponse.deserialize,
)
return self._stubs["partition_query"]
@property
def partition_read(
self,
) -> Callable[[spanner.PartitionReadRequest], Awaitable[spanner.PartitionResponse]]:
r"""Return a callable for the partition read method over gRPC.
Creates a set of partition tokens that can be used to execute a
read operation in parallel. Each of the returned partition
tokens can be used by
[StreamingRead][google.spanner.v1.Spanner.StreamingRead] to
specify a subset of the read result to read. The same session
and read-only transaction must be used by the
PartitionReadRequest used to create the partition tokens and the
ReadRequests that use the partition tokens. There are no
ordering guarantees on rows returned among the returned
partition tokens, or even within each individual StreamingRead
call issued with a partition_token.
Partition tokens become invalid when the session used to create
them is deleted, is idle for too long, begins a new transaction,
or becomes too old. When any of these happen, it is not possible
to resume the read, and the whole operation must be restarted
from the beginning.
Returns:
Callable[[~.PartitionReadRequest],
Awaitable[~.PartitionResponse]]:
A function that, when called, will call the underlying RPC
on the server.
"""
# Generate a "stub function" on-the-fly which will actually make
# the request.
# gRPC handles serialization and deserialization, so we just need
# to pass in the functions for each.
if "partition_read" not in self._stubs:
self._stubs["partition_read"] = self.grpc_channel.unary_unary(
"/google.spanner.v1.Spanner/PartitionRead",
request_serializer=spanner.PartitionReadRequest.serialize,
response_deserializer=spanner.PartitionResponse.deserialize,
)
return self._stubs["partition_read"]
__all__ = ("SpannerGrpcAsyncIOTransport",)