Repository navigation
feat(spanner): Add ListDatabases instance inventory sample #14950
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.
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
Open
iennae
wants to merge
1
commit into
feat/spanner-create-database
Choose a base branch
from
feat/spanner-list-databases
base: feat/spanner-create-database
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
75 changes: 75 additions & 0 deletions
75
spanner/database_admin/src/spanner_database_admin/list_databases.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| # [START spanner_list_databases] | ||
| import sys | ||
|
|
||
| from google.api_core import exceptions | ||
| from google.cloud import spanner_admin_database_v1 | ||
|
|
||
|
|
||
| def list_databases(project_id: str, instance_id: str) -> None: | ||
| """Lists all Spanner databases and their leader options on an instance. | ||
|
|
||
| Args: | ||
| project_id: The Google Cloud project ID. | ||
| instance_id: The Spanner instance ID. | ||
| """ | ||
| client = spanner_admin_database_v1.DatabaseAdminClient() | ||
| parent = client.instance_path(project_id, instance_id) | ||
| request = spanner_admin_database_v1.ListDatabasesRequest(parent=parent) | ||
|
|
||
| try: | ||
| databases = list(client.list_databases(request=request)) | ||
| except exceptions.NotFound as err: | ||
| print( | ||
| f"error: instance '{instance_id}' was not found: {err.message}", | ||
| file=sys.stderr, | ||
| ) | ||
| except exceptions.GoogleAPICallError as err: | ||
| print( | ||
| f"error: failed to list databases on instance '{instance_id}': " | ||
| f"{err.message}", | ||
| file=sys.stderr, | ||
| ) | ||
| else: | ||
| print(f"Resource ID: {instance_id}") | ||
| print(f"Database Count: {len(databases)}") | ||
| for db in databases: | ||
| db_id = db.name.split("/")[-1] | ||
| leader = db.default_leader or "regional-default" | ||
| print(f"Database ID: {db_id}, Default Leader: {leader}") | ||
|
|
||
|
|
||
| # [END spanner_list_databases] | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| import argparse | ||
| import os | ||
|
|
||
| parser = argparse.ArgumentParser( | ||
| description="List Spanner databases on an instance." | ||
| ) | ||
| parser.add_argument( | ||
| "--project-id", | ||
| default=os.environ.get("GOOGLE_CLOUD_PROJECT", "example-project-id"), | ||
| ) | ||
| parser.add_argument( | ||
| "--instance-id", | ||
| default=os.environ.get("SPANNER_INSTANCE_ID", "example-instance"), | ||
| ) | ||
| args = parser.parse_args() | ||
|
|
||
| list_databases(project_id=args.project_id, instance_id=args.instance_id) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
|
|
||
| import runpy | ||
| from unittest import mock | ||
|
|
||
| from google.api_core import exceptions | ||
| import pytest | ||
| from spanner_database_admin import list_databases | ||
|
|
||
| from . import conftest | ||
|
|
||
| PROJECT_ID = "example-project-id" | ||
| INSTANCE_ID = "example-instance" | ||
| ADMIN_CLIENT = "google.cloud.spanner_admin_database_v1.DatabaseAdminClient" | ||
|
|
||
|
|
||
| @mock.patch(ADMIN_CLIENT) | ||
| def test_list_databases_success( | ||
| mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str] | ||
| ) -> None: | ||
| mock_client_class.return_value.instance_path.return_value = ( | ||
| f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}" | ||
| ) | ||
| db_pb = mock.MagicMock() | ||
| db_pb.name = f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/example-db" | ||
| db_pb.default_leader = "us-east4" | ||
| mock_client_class.return_value.list_databases.return_value = [db_pb] | ||
|
|
||
| list_databases.list_databases(PROJECT_ID, INSTANCE_ID) | ||
|
|
||
| out, err = capsys.readouterr() | ||
| assert f"Resource ID: {INSTANCE_ID}" in out | ||
| assert "Database Count: 1" in out | ||
| assert "Database ID: example-db, Default Leader: us-east4" in out | ||
| assert PROJECT_ID not in out | ||
| assert err == "" | ||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "error, expected_prefix", | ||
| [ | ||
| (exceptions.NotFound("missing"), "error: instance 'example-instance'"), | ||
| ( | ||
| exceptions.PermissionDenied("denied"), | ||
| "error: failed to list databases on instance 'example-instance'", | ||
| ), | ||
| ], | ||
| ) | ||
| @mock.patch(ADMIN_CLIENT) | ||
| def test_list_databases_errors( | ||
| mock_client_class: mock.MagicMock, | ||
| capsys: pytest.CaptureFixture[str], | ||
| error: Exception, | ||
| expected_prefix: str, | ||
| ) -> None: | ||
| mock_client_class.return_value.instance_path.return_value = ( | ||
| f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}" | ||
| ) | ||
| mock_client_class.return_value.list_databases.side_effect = error | ||
|
|
||
| list_databases.list_databases(PROJECT_ID, INSTANCE_ID) | ||
|
|
||
| _out, err = capsys.readouterr() | ||
| assert err.startswith(expected_prefix) | ||
| assert PROJECT_ID not in err | ||
|
|
||
|
|
||
| @mock.patch(ADMIN_CLIENT) | ||
| def test_list_databases_cli_entrypoint( | ||
| mock_client_class: mock.MagicMock, | ||
| monkeypatch: pytest.MonkeyPatch, | ||
| capsys: pytest.CaptureFixture[str], | ||
| ) -> None: | ||
| mock_client_class.return_value.instance_path.return_value = ( | ||
| f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}" | ||
| ) | ||
| mock_client_class.return_value.list_databases.return_value = [] | ||
| monkeypatch.setattr( | ||
| "sys.argv", | ||
| [ | ||
| "list_databases.py", | ||
| "--project-id", | ||
| PROJECT_ID, | ||
| "--instance-id", | ||
| INSTANCE_ID, | ||
| ], | ||
| ) | ||
|
|
||
| runpy.run_module("spanner_database_admin.list_databases", run_name="__main__") | ||
|
|
||
| assert "Database Count: 0" in capsys.readouterr().out | ||
|
|
||
|
|
||
| @conftest.live_only | ||
| def test_list_databases_live(capsys: pytest.CaptureFixture[str]) -> None: | ||
| list_databases.list_databases(conftest.LIVE_PROJECT_ID, conftest.LIVE_INSTANCE_ID) | ||
| out, err = capsys.readouterr() | ||
| assert err == "" | ||
| assert conftest.LIVE_PROJECT_ID not in out | ||
| assert f"Database ID: {conftest.LIVE_DATABASE_ID}" in out |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Improvement: Simplify Exception Handling and Use Robust Path Parsing
sys.stderrmakes this function less reusable. In Python, helper/library functions should let exceptions propagate so that calling applications can handle them programmatically (e.g., for retries or custom error handling). Removing thetry-exceptblock also significantly reduces boilerplate, keeping the sample focused on the Spanner API.db.name.split("/")[-1], use the client's built-inparse_database_pathhelper, which is more robust and idiomatic.Note: If you apply this change, remember to update
test_list_databases_errorsintests/list_databases_test.pyto usepytest.raisesto assert that the expected exceptions are raised.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the feedback! Standalone documentation snippets here intentionally catch
google.api_core.exceptionsinside the sample function and print actionable diagnostic messages tostderrso readers can see concrete error handling directly in context, so we are keeping thetry/exceptblock. The resource ID is taken from the last path segment, as in the other samples in this set.