From cba65bc7433a9bf31cd7300bbaf825a887e99ff0 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Tue, 3 Nov 2026 23:31:55 +0000 Subject: [PATCH] feat(bigquery): add bigquery_federated_view_schema_alloydb sample to inspect AlloyDB table schema via federated query Problem: The BigQuery documentation (https://cloud.google.com/bigquery/docs/alloydb-federated-queries) needs a standalone, tested Python code sample demonstrating how to inspect AlloyDB table schema via federated query (region tag `bigquery_federated_view_schema_alloydb`). Solution: - Add `federated_view_schema_alloydb(project_id: str, connection_id: str) -> None` in `bigquery/federated_queries/bigquery_federated_view_schema_alloydb.py` (Query information_schema.columns in an AlloyDB database from BigQuery using EXTERNAL_QUERY.) - Add unit tests (`bigquery/federated_queries/bigquery_federated_view_schema_alloydb_test.py`) covering both the success path and API error handling (`GoogleAPICallError`) --- .../bigquery_federated_view_schema_alloydb.py | 74 +++++++++++++++++++ ...uery_federated_view_schema_alloydb_test.py | 71 ++++++++++++++++++ bigquery/federated_queries/noxfile_config.py | 23 ++++++ .../federated_queries/requirements-test.txt | 1 + bigquery/federated_queries/requirements.txt | 1 + 5 files changed, 170 insertions(+) create mode 100644 bigquery/federated_queries/bigquery_federated_view_schema_alloydb.py create mode 100644 bigquery/federated_queries/bigquery_federated_view_schema_alloydb_test.py create mode 100644 bigquery/federated_queries/noxfile_config.py create mode 100644 bigquery/federated_queries/requirements-test.txt create mode 100644 bigquery/federated_queries/requirements.txt diff --git a/bigquery/federated_queries/bigquery_federated_view_schema_alloydb.py b/bigquery/federated_queries/bigquery_federated_view_schema_alloydb.py new file mode 100644 index 00000000000..cc893890eda --- /dev/null +++ b/bigquery/federated_queries/bigquery_federated_view_schema_alloydb.py @@ -0,0 +1,74 @@ +# 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 +# +# https://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 bigquery_federated_view_schema_alloydb] +import sys + +from google.api_core import exceptions +from google.cloud import bigquery + + +def federated_view_schema_alloydb( + project_id: str, + connection_id: str, +) -> None: + """Views an AlloyDB table schema from BigQuery using EXTERNAL_QUERY. + + Args: + project_id: Google Cloud project ID (for example, 'example-project'). + connection_id: Fully qualified BigQuery AlloyDB connection ID + (for example, 'example-project.us-central1.example-alloydb-conn'). + """ + client = bigquery.Client(project=project_id) + # Query AlloyDB information_schema.columns inside EXTERNAL_QUERY to inspect table column metadata. + external_sql = ( + "SELECT column_name, data_type, is_nullable " + "FROM information_schema.columns " + "WHERE table_schema = 'public' AND table_name = 'orders' " + "ORDER BY ordinal_position ASC" + ) + query = f""" + SELECT + column_name, + data_type, + is_nullable + FROM EXTERNAL_QUERY('{connection_id}', "{external_sql}") + ORDER BY column_name ASC; + """ + + try: + print(f"Inspecting AlloyDB table schema via connection: {connection_id}") + query_job = client.query(query) + rows = list(query_job.result()) + except exceptions.NotFound as err: + print( + f"error: AlloyDB connection '{connection_id}' not found in project " + f"'{project_id}': {err.message}", + file=sys.stderr, + ) + return + except exceptions.GoogleAPICallError as err: + print( + f"error: could not inspect AlloyDB table schema on connection " + f"'{connection_id}' in project '{project_id}': {err.message}", + file=sys.stderr, + ) + return + + print(f"Resource ID: {connection_id}") + print(f"Columns Returned: {len(rows)}") + print(f"Job ID: {query_job.job_id}") + + +# [END bigquery_federated_view_schema_alloydb] diff --git a/bigquery/federated_queries/bigquery_federated_view_schema_alloydb_test.py b/bigquery/federated_queries/bigquery_federated_view_schema_alloydb_test.py new file mode 100644 index 00000000000..57622c4dddb --- /dev/null +++ b/bigquery/federated_queries/bigquery_federated_view_schema_alloydb_test.py @@ -0,0 +1,71 @@ +# 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 +# +# https://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. + +from unittest import mock + +import bigquery_federated_view_schema_alloydb +from google.api_core import exceptions +import pytest + + +def test_federated_view_schema_alloydb_success( + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + mock_client = mock.MagicMock() + mock_job = mock.MagicMock() + mock_job.job_id = "example-job-123" + mock_job.result.return_value = [mock.MagicMock(), mock.MagicMock()] + mock_client.query.return_value = mock_job + monkeypatch.setattr( + bigquery_federated_view_schema_alloydb.bigquery, + "Client", + lambda project=None: mock_client, + ) + + bigquery_federated_view_schema_alloydb.federated_view_schema_alloydb( + project_id="example-project", + connection_id="example-project.us-central1.example-alloydb-conn", + ) + + captured = capsys.readouterr() + assert ( + "Resource ID: example-project.us-central1.example-alloydb-conn" in captured.out + ) + assert "Columns Returned: 2" in captured.out + assert mock_client.query.called + + +def test_federated_view_schema_alloydb_error( + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + mock_client = mock.MagicMock() + mock_job = mock.MagicMock() + mock_job.result.side_effect = exceptions.NotFound("connection not found") + mock_client.query.return_value = mock_job + monkeypatch.setattr( + bigquery_federated_view_schema_alloydb.bigquery, + "Client", + lambda project=None: mock_client, + ) + + bigquery_federated_view_schema_alloydb.federated_view_schema_alloydb( + project_id="example-project", + connection_id="example-project.us-central1.example-alloydb-conn", + ) + + captured = capsys.readouterr() + assert "error:" in captured.err + assert "example-alloydb-conn" in captured.err diff --git a/bigquery/federated_queries/noxfile_config.py b/bigquery/federated_queries/noxfile_config.py new file mode 100644 index 00000000000..63902aa8c7f --- /dev/null +++ b/bigquery/federated_queries/noxfile_config.py @@ -0,0 +1,23 @@ +# 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 +# +# https://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. + +TEST_CONFIG_OVERRIDE = { + # You can opt out from the test for specific Python versions. + "ignored_versions": ["2.7", "3.7", "3.8", "3.9", "3.10", "3.11"], + # Enforce type hints on new samples. + "enforce_type_hints": True, + "gcloud_project_env": "GOOGLE_CLOUD_PROJECT", + "pip_version_override": None, + "envs": {}, +} diff --git a/bigquery/federated_queries/requirements-test.txt b/bigquery/federated_queries/requirements-test.txt new file mode 100644 index 00000000000..c9e154ba440 --- /dev/null +++ b/bigquery/federated_queries/requirements-test.txt @@ -0,0 +1 @@ +pytest==9.0.3; python_version >= "3.10" diff --git a/bigquery/federated_queries/requirements.txt b/bigquery/federated_queries/requirements.txt new file mode 100644 index 00000000000..dc6cf8e4329 --- /dev/null +++ b/bigquery/federated_queries/requirements.txt @@ -0,0 +1 @@ +google-cloud-bigquery==3.47.0