chore: Moved admin client to google.cloud.bigtable.admin/admin_v2 #1204

gkevinzheng · 2025-09-04T19:50:30Z

Changes:

Moved the admin library from google.cloud.bigtable_admin/bigtable_admin_v2 to google.cloud.bigtable.admin. The autogenerated portion of the library was generated as follows:

py_gapic_library(
    name = "bigtable_admin_py_gapic",
    srcs = [":admin_proto"],
    grpc_service_config = "bigtableadmin_grpc_service_config.json",
    opt_args = [
        "python-gapic-namespace=google.cloud.bigtable",
        "python-gapic-name=admin",
    ],
    rest_numeric_enums = True,
    service_yaml = "bigtableadmin_v2.yaml",
    transport = "grpc+rest",
    deps = [
        "//google/iam/v1:iam_policy_py_proto",
    ],
)

This change will be committed close to when we will release the v3 client.

Created import aliasing to make sure that old imports from bigtable_admin/bigtable_admin_v2 still work as intended.
Created unit tests for the import aliasing. Since there's an existing layer of import aliasing for objects within the GAPIC library, we create unit tests to make sure the composition of existing and new import aliasing works as intended.
Made the classic client use the new selective GAPIC BigtableTableAdminClient instead of the BaseBigtableTableAdminClient as its table admin client.

Fixes #1155

snippet-bot · 2025-09-04T19:51:04Z

No region tags are edited in this PR.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

daniel-sanche · 2025-09-05T20:03:08Z

docs/index.rst


   data_client/data_client_usage
   classic_client/usage
+   admin_client/admin_client_usage


I probably would have preferred to have the new docs as a separate PR to keep things focused, but probably not a big deal

daniel-sanche · 2025-09-05T20:04:44Z

google/cloud/bigtable/admin_v2/__init__.py

@@ -0,0 +1,274 @@
+# -*- coding: utf-8 -*-


do we have to have both google.cloud.bigtable.admin and google.cloud.bigtable.admin_v2? I thought we'd just need google.cloud.bigtable.admin

It seems confusing to have google.cloud.bigtable.admin, google.cloud.bigtable.admin_v2, google.cloud.bigtable_admin, and google.cloud.bigtable.admin_v2. Maybe we should reconsider

The GAPIC structure is that google.cloud.bigtable.admin aliases to google.cloud.bigtable.admin_v<version>

daniel-sanche · 2025-09-05T20:11:44Z

google/cloud/bigtable/admin/overlay/services/bigtable_table_admin/__init__.py

-#
-from .client import BigtableTableAdminClient
+
+# TODO: Add the async client after owlbot changes.


What does this mean?

Old TODO comment from before that I should delete

daniel-sanche · 2025-09-05T20:14:37Z

owlbot.py


+# --------------------------------------------------------------------------
+# Admin Overlay work
+# --------------------------------------------------------------------------


I'm a bit confused why these new owlbot changes have to be added? Why are they only needed after this move?

v3_staging doesn't have the selective GAPIC client in it right now, so I added it back in.

daniel-sanche · 2025-09-05T20:15:09Z

...erated_samples/bigtableadmin_v2_generated_bigtable_instance_admin_create_app_profile_sync.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-


do we need to merge main into v3_staging?

daniel-sanche · 2025-09-05T20:35:41Z

Maybe we should make a small doc to make sure we're all aligned on what the final structure will look like? I'd hate to spend a lot of time iterating here if we have to move things back and forth a bunch

Good to see import aliases aren't going to be a problem though

daniel-sanche · 2025-11-19T21:03:04Z

It looks like the overlay and utils are duplicated in google/cloud/bigtable/admin and google/cloud/bigtable_admin_v2. Is that intentional?

daniel-sanche · 2025-11-19T21:05:35Z

google/cloud/bigtable_admin/__init__.py

-from google.cloud.bigtable_admin_v2.overlay import *  # noqa: F401, F403
-
-__all__ += google.cloud.bigtable_admin_v2.overlay.__all__
+__all__ = google.cloud.bigtable.admin.__all__


Do we have test that try importing in different ways, to make sure they all work the same as before?

i.e. import google.cloud.bigtable.admin.Type, from google.cloud.bigtable.admin import Type, etc

parthea · 2025-11-19T21:14:27Z

owlbot.py

    is_fresh_admin_v2_copy = \
-        s.move(library / "google/cloud/bigtable_admin_v2", excludes=["**/gapic_version.py"])
-    s.move(library / "tests")
+        s.move(library / "google/cloud/bigtable/admin_v2",


Do we need a CL to change google/cloud/bigtable_admin_v2 to google/cloud/bigtable/admin_v2?

Currently we generate google/cloud/bigtable_admin_v2

https://github.com/googleapis/googleapis-gen/tree/master/google/bigtable/admin/v2/bigtable-admin-v2-py/google/cloud/bigtable_admin_v2

If we want google/cloud/bigtable/admin_v2 then we'll need to delete these lines
https://github.com/googleapis/googleapis/blob/a17b84add8318f780fcc8a027815d5fee644b9f7/google/bigtable/admin/v2/BUILD.bazel#L173-L174

This is going to be merged into a staging branch. Closer to when that branch will be merged to main I will submit the CL to change google/cloud/bigtable_admin_v2 to google/cloud/bigtable/admin_v2.

parthea · 2025-11-19T21:15:27Z

owlbot.py

    is_fresh_admin_v2_copy = \
-        s.move(library / "google/cloud/bigtable_admin_v2", excludes=["**/gapic_version.py"])
-    s.move(library / "tests")
+        s.move(library / "google/cloud/bigtable/admin_v2",


Could we merge #1232 first since we're moving off of owlbot.py?

Note that this is going to a staging branch, not main, so it won't interfere with that work

Although I was concerned about whether that would cause merge conflicts here. So maybe we should still consider the ordering

gkevinzheng · 2025-11-20T17:56:37Z

It looks like the overlay and utils are duplicated in google/cloud/bigtable/admin and google/cloud/bigtable_admin_v2. Is that intentional?

Not intentional, will be removing them now.

daniel-sanche · 2025-11-20T22:12:56Z

google/cloud/bigtable_admin_v2/__init__.py

+):
+    mod = importlib.import_module(name)
+    alias = name.replace(_NEW_PATH, __name__, 1)
+    sys.modules[alias] = mod


I'm curious why this is so different than google/cloud/bigtable_admin/__init__.py. Aren't they both aliases?

daniel-sanche · 2025-11-20T22:14:00Z

google/cloud/bigtable_admin/__init__.py


-__version__ = package_version.__version__
+# There are no subpackages exported from google.cloud.bigtable_admin,
+# only an import alias for objects in google.cloud.bigtable_admin_v2.


it says alias of google.cloud.bigtable_admin_v2, but it looks like it's actually aliasing google.cloud.bigtable.admin? (Although I understand they should all be equivalent)

daniel-sanche · 2025-11-22T00:49:35Z

You should also consider moving the classic client alongside the others, something like this: #1200

Probably not in this PR though. We can consider that near the end

chore: Moved admin client to google.cloud.bigtable.admin/admin_v2

2a3cd00

gkevinzheng requested review from a team as code owners September 4, 2025 19:50

gkevinzheng requested review from daniel-sanche and rsamborski and removed request for a team September 4, 2025 19:50

blunderbuss-gcf bot assigned shantstepanian Sep 4, 2025

product-auto-label bot added size: xl Pull request size is extra large. api: bigtable Issues related to the googleapis/python-bigtable API. labels Sep 4, 2025

gkevinzheng removed the request for review from rsamborski September 4, 2025 19:50

gkevinzheng unassigned shantstepanian Sep 4, 2025

Fixed docs and linting

2f483c3

daniel-sanche requested changes Sep 5, 2025

View reviewed changes

Move admin client to google.cloud.bigtable.admin, no _v2

d114ab4

blunderbuss-gcf bot assigned kongweihan Nov 6, 2025

gkevinzheng added 2 commits November 6, 2025 21:26

Merge branch 'v3_staging' into move-admin-files

438c7fb

Fixed tests after merge conflicts

aa2850c

gkevinzheng added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 10, 2025

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Nov 10, 2025

gkevinzheng added 2 commits November 18, 2025 15:26

Fixed 3.14 annotation overloading issue

b2acdd4

Ignore import statement in linting

bb49a72

more linting

13a3051

daniel-sanche reviewed Nov 19, 2025

View reviewed changes

parthea reviewed Nov 19, 2025

View reviewed changes

Add more tests for imports

484540f

Removed overlay and utils from older bigtable_admin_v2 package

0a9bb18

daniel-sanche reviewed Nov 20, 2025

View reviewed changes

chore: Moved admin client to google.cloud.bigtable.admin/admin_v2 #1204

Are you sure you want to change the base?

chore: Moved admin client to google.cloud.bigtable.admin/admin_v2 #1204

Conversation

gkevinzheng commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

snippet-bot bot commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

No region tags are edited in this PR.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daniel-sanche commented Sep 5, 2025

Uh oh!

daniel-sanche commented Nov 19, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gkevinzheng commented Nov 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

daniel-sanche commented Nov 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

gkevinzheng commented Sep 4, 2025 •

edited

Loading

snippet-bot bot commented Sep 4, 2025 •

edited

Loading