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

Commit 67af089

Browse files
committed
docs(async): mark new AsyncIO APIs as experimental
1 parent e5638ab commit 67af089

File tree

16 files changed

+48
-31
lines changed

16 files changed

+48
-31
lines changed

google/cloud/spanner_v1/_async/batch.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
DEFAULT_RETRY_TIMEOUT_SECS = 30
5151

5252

53+
# Experimental API - Please note that this API is currently experimental and can change in the future.
5354
class _BatchBase(_SessionWrapper):
5455
"""Accumulate mutations for transmission during :meth:`commit`.
5556

google/cloud/spanner_v1/_async/client.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,7 @@ def _initialize_metrics(project, credentials):
167167
)
168168

169169

170+
# Experimental API - Please note that this API is currently experimental and can change in the future.
170171
class Client(ClientWithProject):
171172
"""Client for interacting with Cloud Spanner API.
172173

google/cloud/spanner_v1/_async/database.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@
115115
DEFAULT_RETRY_BACKOFF = AsyncRetry(initial=0.02, maximum=32, multiplier=1.3)
116116

117117

118+
# Experimental API - Please note that this API is currently experimental and can change in the future.
118119
class Database(object):
119120
"""Representation of a Cloud Spanner Database.
120121

google/cloud/spanner_v1/_async/instance.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ def _type_string_to_type_pb(type_string):
8181

8282

8383
@CrossSync.convert_class(add_mapping_for_name="Instance")
84+
# Experimental API - Please note that this API is currently experimental and can change in the future.
8485
class Instance(object):
8586
"""Representation of a Cloud Spanner Instance.
8687

google/cloud/spanner_v1/_async/pool.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ async def __aexit__(self, exc_type, exc_value, traceback):
7373

7474

7575
@CrossSync.convert_class
76+
# Experimental API - Please note that this API is currently experimental and can change in the future.
7677
class AbstractSessionPool(object):
7778
"""Specifies required API for concrete session pool implementations.
7879
@@ -209,6 +210,7 @@ def session(self, **kwargs):
209210

210211

211212
@CrossSync.convert_class
213+
# Experimental API - Please note that this API is currently experimental and can change in the future.
212214
class FixedSizePool(AbstractSessionPool):
213215
"""Concrete session pool implementation:
214216
@@ -475,6 +477,7 @@ async def clear(self):
475477

476478

477479
@CrossSync.convert_class
480+
# Experimental API - Please note that this API is currently experimental and can change in the future.
478481
class BurstyPool(AbstractSessionPool):
479482
"""Concrete session pool implementation:
480483
@@ -586,6 +589,7 @@ async def clear(self):
586589

587590

588591
@CrossSync.convert_class
592+
# Experimental API - Please note that this API is currently experimental and can change in the future.
589593
class PingingPool(FixedSizePool):
590594
"""Concrete session pool implementation:
591595
@@ -835,6 +839,7 @@ async def ping(self):
835839

836840

837841
@CrossSync.convert_class
842+
# Experimental API - Please note that this API is currently experimental and can change in the future.
838843
class TransactionPingingPool(PingingPool):
839844
"""Concrete session pool implementation:
840845

google/cloud/spanner_v1/_async/session.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848

4949

5050
@total_ordering
51+
# Experimental API - Please note that this API is currently experimental and can change in the future.
5152
class Session(object):
5253
"""Representation of a Cloud Spanner Session.
5354

google/cloud/spanner_v1/_async/snapshot.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -776,6 +776,7 @@ def _update_for_precommit_token_pb_unsafe(
776776
self._precommit_token = precommit_token_pb
777777

778778

779+
# Experimental API - Please note that this API is currently experimental and can change in the future.
779780
class Snapshot(_SnapshotBase):
780781
"""Allow a set of reads / SQL statements with shared staleness."""
781782

google/cloud/spanner_v1/_async/streamed.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
from google.cloud.spanner_v1.types.type import TypeCode
2424

2525

26+
# Experimental API - Please note that this API is currently experimental and can change in the future.
2627
class StreamedResultSet(object):
2728
"""Process a sequence of partial result sets into a single set of row data.
2829

google/cloud/spanner_v1/_async/transaction.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@
5454
from google.cloud.spanner_v1.types.transaction import TransactionOptions
5555

5656

57+
# Experimental API - Please note that this API is currently experimental and can change in the future.
5758
class Transaction(_SnapshotBase, _BatchBase):
5859
"""Implement read-write transaction semantics for a session.
5960

google/cloud/spanner_v1/batch.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ def wrapped_method():
243243
max_commit_delay=max_commit_delay,
244244
request_options=request_options,
245245
)
246-
call_metadata, error_augmenter = database.with_error_augmentation(
246+
(call_metadata, error_augmenter) = database.with_error_augmentation(
247247
getattr(database, "_next_nth_request", 0), 1, metadata, span
248248
)
249249
commit_method = functools.partial(

0 commit comments

Comments
 (0)