Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,6 @@ replacements:
:maxdepth: 3

data_client/data_client_usage
classic_client/usage
admin_client/admin_client_usage
count: 1
- paths: [
Expand All @@ -340,29 +339,21 @@ replacements:
.. _Product Documentation: https://cloud.google.com/bigtable/docs


Async Data Client
-------------------------
Data Client
-----------

:code:`v2.23.0` includes a release of the new :code:`BigtableDataClientAsync` client, accessible at the import path
:code:`google.cloud.bigtable.data`.

The new client brings a simplified API and increased performance using asyncio.
The new client is focused on the data API (i.e. reading and writing Bigtable data), with admin operations
remaining exclusively in the existing synchronous client.

Feedback and bug reports are welcome at cbt-python-client-v3-feedback@google.com,
or through the Github `issue tracker`_.
The modern Data Client is accessible at the import path :code:`google.cloud.bigtable.data` and provides both
synchronous (:code:`BigtableDataClient`) and asynchronous (:code:`BigtableDataClientAsync`) surfaces.

The Data Client brings a simplified API and increased performance focused on reading and writing Bigtable data.
Admin operations (such as table and instance management) are handled via :code:`google.cloud.bigtable_admin_v2`.

.. note::

It is generally not recommended to use the async client in an otherwise synchronous codebase. To make use of asyncio's
performance benefits, the codebase should be designed to be async from the ground up.


.. _issue tracker: https://github.com/googleapis/google-cloud-python/issues


Quick Start
count: 1
# Note: noxfile.py is heavily customized so we clobber the whole file.
Expand Down Expand Up @@ -872,9 +863,6 @@ replacements:
os.path.join("docs", ""),
os.path.join("docs", "_build", "html", ""),
)
# Customization: Add extra sections to the table of contents for the Classic vs Async clients
session.install("pyyaml")
session.run("python", "docs/scripts/patch_devsite_toc.py")


@nox.session(python=DEFAULT_PYTHON_VERSION)
Expand Down
20 changes: 6 additions & 14 deletions packages/google-cloud-bigtable/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,21 @@ a Google Cloud project.
.. _Product Documentation: https://cloud.google.com/bigtable/docs


Async Data Client
-------------------------

:code:`v2.23.0` includes a release of the new :code:`BigtableDataClientAsync` client, accessible at the import path
:code:`google.cloud.bigtable.data`.

The new client brings a simplified API and increased performance using asyncio.
The new client is focused on the data API (i.e. reading and writing Bigtable data), with admin operations
remaining exclusively in the existing synchronous client.
Data Client
-----------

Feedback and bug reports are welcome at cbt-python-client-v3-feedback@google.com,
or through the Github `issue tracker`_.
The modern Data Client is accessible at the import path :code:`google.cloud.bigtable.data` and provides both
synchronous (:code:`BigtableDataClient`) and asynchronous (:code:`BigtableDataClientAsync`) surfaces.

The Data Client brings a simplified API and increased performance focused on reading and writing Bigtable data.
Admin operations (such as table and instance management) are handled via :code:`google.cloud.bigtable_admin_v2`.

.. note::

It is generally not recommended to use the async client in an otherwise synchronous codebase. To make use of asyncio's
performance benefits, the codebase should be designed to be async from the ground up.


.. _issue tracker: https://github.com/googleapis/google-cloud-python/issues


Quick Start
-----------

Expand Down
10 changes: 9 additions & 1 deletion packages/google-cloud-bigtable/docs/admin_client/types_.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ Types for Google Cloud Bigtable Admin v2 API
:members:
:show-inheritance:

.. automodule:: google.cloud.bigtable_admin_v2.overlay.types
.. autoclass:: google.cloud.bigtable_admin_v2.AsyncRestoreTableOperation
:members:
:show-inheritance:

.. autoclass:: google.cloud.bigtable_admin_v2.RestoreTableOperation
:members:
:show-inheritance:

.. autoclass:: google.cloud.bigtable_admin_v2.WaitForConsistencyRequest
:members:
:show-inheritance:

This file was deleted.

This file was deleted.

13 changes: 0 additions & 13 deletions packages/google-cloud-bigtable/docs/classic_client/batcher.rst

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading
Loading