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

Commit 80223f9

Browse files
committed
added recommended way
1 parent 3ddfb0c commit 80223f9

1 file changed

Lines changed: 19 additions & 5 deletions

File tree

UPGRADING.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,37 @@ The v3.0.0 release of `google-cloud-bigtable` deprecates the previous `google.cl
66
- `google.cloud.bigtable.data.BigtableDataClientAsync`
77
- Admin API:
88
- `google.cloud.bigtable.admin.BigtableInstanceAdminClient`
9-
- `google.cloud.bigtable.admin.BigtableInstanceAdminClientAsync`
9+
- `google.cloud.bigtable.admin.BigtableInstanceAdminAsyncClient`
1010
- `google.cloud.bigtable.admin.BigtableTableAdminClient`
11-
- `google.cloud.bigtable.admin.BigtableTableAdminClientAsync`
11+
- `google.cloud.bigtable.admin.BigtableTableAdminAsyncClient`
1212

1313
The deprecated client will remain available as an alternative API surface, which internally delegates calls to the respective new clients. For most users, existing code will continue to work as before. But there may be some breaking changes associated with this update, which are detailed in this document.
1414

1515
### Admin Client Migration
1616

17-
While we do recommend you instantiate the new admin API clients directly, you can access the new admin API
18-
clients via the `google.cloud.bigtable.Client` class:
17+
We recommend that you instantiate the new admin API clients directly:
18+
19+
```
20+
from google.cloud.bigtable.admin import (
21+
BigtableInstanceAdminClient,
22+
BigtableInstanceAdminAsyncClient,
23+
BigtableTableAdminClient,
24+
BigtableTableAdminAsyncClient,
25+
)
26+
27+
instance_admin_client = BigtableInstanceAdminClient()
28+
instance_admin_async_client = BigtableInstanceAdminAsyncClient()
29+
table_admin_client = BigtableTableAdminClient()
30+
table_admin_async_client = BigtableTableAdminAsyncClient()
31+
```
32+
33+
Access to the new admin API sync clients via the `google.cloud.bigtable.Client` class is also supported for backwards compatibility:
1934

2035
```
2136
from google.cloud.bigtable import Client
2237
2338
client = Client()
2439
25-
2640
# google.cloud.bigtable.admin.BigtableInstanceAdminClient
2741
instance_admin_client = client.instance_admin_client()
2842

0 commit comments

Comments
 (0)