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

Commit 928823a

Browse files
committed
add UPGRADING.md
1 parent 7926aa5 commit 928823a

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

UPGRADING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# 3.0.0 Migration Guide
2+
3+
Description TBD
4+
5+
The v3.0.0 release of `google-cloud-bigtable` deprecates the previous `google.cloud.bigtable.Client` class in favor of distinct clients for the two API surfaces, supporting both sync and async calls:
6+
- Data API: `google.cloud.bigtable.data.BigtableDataClient` and `google.cloud.bigtable.data.BigtableDataClientAsync`
7+
- Admin API: `google.cloud.bigtable.admin.BigtableInstanceAdminClient`, `google.cloud.bigtable.admin.BigtableInstanceAdminClientAsync`, `google.cloud.bigtable.admin.BigtableTableAdminClient`, and `google.cloud.bigtable.admin.BigtableTableAdminClientAsync`
8+
9+
The deprecated client will remain available as an alternative API surface to the new clients. For most users, existing code will continue to work as before. But there may be some behavior changes associated with this update, which are detailed in this document.
10+
11+
If you experience technical issues or have questions, please file an [issue](https://github.com/googleapis/python-bigtable/issues).
12+
13+
## Breaking Changes
14+
- **[MutationBatcher](n-bigtable/blob/main/google/cloud/bigtable/data/_sync_autogen/mutations_batcher.py#L151) and [MutationBatcherAsync](https://github.com/googleapis/python-bigtable/blob/main/google/cloud/bigtable/data/_async/mutations_batcher.py#L182)'s `table` argument was renamed to `target`**, since it also supports [Authorized View](https://github.com/googleapis/python-bigtable/pull/1034) instances. This matches the naming uses in other classes (https://github.com/googleapis/python-bigtable/pull/1153)

0 commit comments

Comments
 (0)