Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: v3_staging
Choose a base branch
from
Open

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

wants to merge 2 commits into from

Conversation

gkevinzheng
Copy link
Contributor

Changes:

  1. Moved the admin library from google.cloud.bigtable_admin/bigtable_admin_v2 to google.cloud.bigtable.admin/admin_v2. This is more in line with what was initially planned. 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.

  1. Created import aliasing to make sure that old imports from bigtable_admin/bigtable_admin_v2 still work as intended.
  2. 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.
  3. Made the classic client use the new selective GAPIC BigtableTableAdminClient instead of the BaseBigtableTableAdminClient as its table admin client.

@gkevinzheng gkevinzheng requested review from a team as code owners September 4, 2025 19:50
@gkevinzheng gkevinzheng requested review from daniel-sanche and rsamborski and removed request for a team September 4, 2025 19:50
@product-auto-label 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 gkevinzheng removed the request for review from rsamborski September 4, 2025 19:50
@snippet-bot Snippet Bot
Copy link

snippet-bot bot commented Sep 4, 2025 •
edited
Loading

Here is the summary of changes.

You are about to add 132 region tags.

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
daniel-sanche requested changes Sep 5, 2025
View reviewed changes
docs/index.rst

data_client/data_client_usage
classic_client/usage
admin_client/admin_client_usage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

google/cloud/bigtable/admin_v2/__init__.py
@@ -0,0 +1,274 @@
# -*- coding: utf-8 -*-
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

google/cloud/bigtable/admin_v2/overlay/services/bigtable_table_admin/__init__.py
#
from .client import BigtableTableAdminClient

# TODO: Add the async client after owlbot changes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does this mean?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Old TODO comment from before that I should delete

owlbot.py

# --------------------------------------------------------------------------
# Admin Overlay work
# --------------------------------------------------------------------------
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

...erated_samples/bigtableadmin_v2_generated_bigtable_instance_admin_create_app_profile_sync.py
@@ -0,0 +1,57 @@
# -*- coding: utf-8 -*-
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need to merge main into v3_staging?

@daniel-sanche
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@daniel-sanche daniel-sanche daniel-sanche requested changes

Assignees

No one assigned

Labels

api: bigtable Issues related to the googleapis/python-bigtable API. size: xl Pull request size is extra large.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@gkevinzheng @daniel-sanche @shantstepanian