Skip to content

Commit 1cc1ff7

Browse files
chore(docs): remove preview warning for async data client (#945)
* remove preview from READMEs * removed preview warning from docstrings * added note to data_api page
1 parent 3badd48 commit 1cc1ff7

File tree

4 files changed

+11
-44
lines changed

4 files changed

+11
-44
lines changed

README.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,16 @@ Analytics, Maps, and Gmail.
2121
.. _Product Documentation: https://cloud.google.com/bigtable/docs
2222

2323

24-
Preview Async Data Client
24+
Async Data Client
2525
-------------------------
2626

27-
:code:`v2.23.0` includes a preview release of the new :code:`BigtableDataClientAsync` client, accessible at the import path
27+
:code:`v2.23.0` includes a release of the new :code:`BigtableDataClientAsync` client, accessible at the import path
2828
:code:`google.cloud.bigtable.data`.
2929

3030
The new client brings a simplified API and increased performance using asyncio, with a corresponding synchronous surface
3131
coming soon. The new client is focused on the data API (i.e. reading and writing Bigtable data), with admin operations
3232
remaining in the existing client.
3333

34-
:code:`BigtableDataClientAsync` is currently in preview, and is not recommended for production use.
35-
3634
Feedback and bug reports are welcome at [email protected],
3735
or through the Github `issue tracker`_.
3836

docs/data-api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
Data API
22
========
33

4+
.. note::
5+
This page describes how to use the Data API with the synchronous Bigtable client.
6+
Examples for using the Data API with the async client can be found in the
7+
`Getting Started Guide`_.
8+
9+
.. _Getting Started Guide: https://cloud.google.com/bigtable/docs/samples-python-hello
10+
411
After creating a :class:`Table <google.cloud.bigtable.table.Table>` and some
512
column families, you are ready to store and retrieve data.
613

google/cloud/bigtable/data/README.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
Async Data Client Preview
2-
=========================
3-
4-
This new client is currently in preview, and is not recommended for production use.
1+
Async Data Client
2+
=================
53

64
Synchronous API surface and usage examples coming soon
75

google/cloud/bigtable/data/_async/client.py

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,6 @@ def __init__(
101101
102102
Client should be created within an async context (running event loop)
103103
104-
Warning: BigtableDataClientAsync is currently in preview, and is not
105-
yet recommended for production use.
106-
107104
Args:
108105
project: the project which the client acts on behalf of.
109106
If not passed, falls back to the default inferred
@@ -566,9 +563,6 @@ async def read_rows_stream(
566563
Failed requests within operation_timeout will be retried based on the
567564
retryable_errors list until operation_timeout is reached.
568565
569-
Warning: BigtableDataClientAsync is currently in preview, and is not
570-
yet recommended for production use.
571-
572566
Args:
573567
- query: contains details about which rows to return
574568
- operation_timeout: the time budget for the entire operation, in seconds.
@@ -620,9 +614,6 @@ async def read_rows(
620614
Failed requests within operation_timeout will be retried based on the
621615
retryable_errors list until operation_timeout is reached.
622616
623-
Warning: BigtableDataClientAsync is currently in preview, and is not
624-
yet recommended for production use.
625-
626617
Args:
627618
- query: contains details about which rows to return
628619
- operation_timeout: the time budget for the entire operation, in seconds.
@@ -669,9 +660,6 @@ async def read_row(
669660
Failed requests within operation_timeout will be retried based on the
670661
retryable_errors list until operation_timeout is reached.
671662
672-
Warning: BigtableDataClientAsync is currently in preview, and is not
673-
yet recommended for production use.
674-
675663
Args:
676664
- query: contains details about which rows to return
677665
- operation_timeout: the time budget for the entire operation, in seconds.
@@ -727,9 +715,6 @@ async def read_rows_sharded(
727715
results = await table.read_rows_sharded(shard_queries)
728716
```
729717
730-
Warning: BigtableDataClientAsync is currently in preview, and is not
731-
yet recommended for production use.
732-
733718
Args:
734719
- sharded_query: a sharded query to execute
735720
- operation_timeout: the time budget for the entire operation, in seconds.
@@ -810,9 +795,6 @@ async def row_exists(
810795
Return a boolean indicating whether the specified row exists in the table.
811796
uses the filters: chain(limit cells per row = 1, strip value)
812797
813-
Warning: BigtableDataClientAsync is currently in preview, and is not
814-
yet recommended for production use.
815-
816798
Args:
817799
- row_key: the key of the row to check
818800
- operation_timeout: the time budget for the entire operation, in seconds.
@@ -867,9 +849,6 @@ async def sample_row_keys(
867849
RowKeySamples is simply a type alias for list[tuple[bytes, int]]; a list of
868850
row_keys, along with offset positions in the table
869851
870-
Warning: BigtableDataClientAsync is currently in preview, and is not
871-
yet recommended for production use.
872-
873852
Args:
874853
- operation_timeout: the time budget for the entire operation, in seconds.
875854
Failed requests will be retried within the budget.i
@@ -942,9 +921,6 @@ def mutations_batcher(
942921
Can be used to iteratively add mutations that are flushed as a group,
943922
to avoid excess network calls
944923
945-
Warning: BigtableDataClientAsync is currently in preview, and is not
946-
yet recommended for production use.
947-
948924
Args:
949925
- flush_interval: Automatically flush every flush_interval seconds. If None,
950926
a table default will be used
@@ -994,9 +970,6 @@ async def mutate_row(
994970
Idempotent operations (i.e, all mutations have an explicit timestamp) will be
995971
retried on server failure. Non-idempotent operations will not.
996972
997-
Warning: BigtableDataClientAsync is currently in preview, and is not
998-
yet recommended for production use.
999-
1000973
Args:
1001974
- row_key: the row to apply mutations to
1002975
- mutations: the set of mutations to apply to the row
@@ -1077,9 +1050,6 @@ async def bulk_mutate_rows(
10771050
will be retried on failure. Non-idempotent will not, and will reported in a
10781051
raised exception group
10791052
1080-
Warning: BigtableDataClientAsync is currently in preview, and is not
1081-
yet recommended for production use.
1082-
10831053
Args:
10841054
- mutation_entries: the batches of mutations to apply
10851055
Each entry will be applied atomically, but entries will be applied
@@ -1128,9 +1098,6 @@ async def check_and_mutate_row(
11281098
11291099
Non-idempotent operation: will not be retried
11301100
1131-
Warning: BigtableDataClientAsync is currently in preview, and is not
1132-
yet recommended for production use.
1133-
11341101
Args:
11351102
- row_key: the key of the row to mutate
11361103
- predicate: the filter to be applied to the contents of the specified row.
@@ -1199,9 +1166,6 @@ async def read_modify_write_row(
11991166
12001167
Non-idempotent operation: will not be retried
12011168
1202-
Warning: BigtableDataClientAsync is currently in preview, and is not
1203-
yet recommended for production use.
1204-
12051169
Args:
12061170
- row_key: the key of the row to apply read/modify/write rules to
12071171
- rules: A rule or set of rules to apply to the row.

0 commit comments

Comments
 (0)