From 16d364039122374d35d49cf4504f6c7b54874235 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Tue, 3 Nov 2026 23:31:53 +0000 Subject: [PATCH] feat(bigquery): add bigquery_query_biglake_gcs_temp_table sample to query a temporary BigLake table on Cloud Storage Problem: The BigQuery documentation (https://cloud.google.com/bigquery/docs/query-cloud-storage-using-biglake) needs a standalone, tested Python code sample demonstrating how to query a temporary BigLake table on Cloud Storage (region tag `bigquery_query_biglake_gcs_temp_table`). Solution: - Add `query_biglake_gcs_temp_table(project_id: str, connection_id: str) -> None` in `bigquery/biglake/bigquery_query_biglake_gcs_temp_table.py` (Configure an ephemeral BigLake table definition over Cloud Storage files using ExternalConfig and query it within a single job.) - Add unit tests (`bigquery/biglake/bigquery_query_biglake_gcs_temp_table_test.py`) covering both the success path and API error handling (`GoogleAPICallError`) --- .../bigquery_query_biglake_gcs_temp_table.py | 89 +++++++++++++++++++ ...query_query_biglake_gcs_temp_table_test.py | 72 +++++++++++++++ bigquery/biglake/noxfile_config.py | 23 +++++ bigquery/biglake/requirements-test.txt | 1 + bigquery/biglake/requirements.txt | 2 + 5 files changed, 187 insertions(+) create mode 100644 bigquery/biglake/bigquery_query_biglake_gcs_temp_table.py create mode 100644 bigquery/biglake/bigquery_query_biglake_gcs_temp_table_test.py create mode 100644 bigquery/biglake/noxfile_config.py create mode 100644 bigquery/biglake/requirements-test.txt create mode 100644 bigquery/biglake/requirements.txt diff --git a/bigquery/biglake/bigquery_query_biglake_gcs_temp_table.py b/bigquery/biglake/bigquery_query_biglake_gcs_temp_table.py new file mode 100644 index 00000000000..ae35cf68242 --- /dev/null +++ b/bigquery/biglake/bigquery_query_biglake_gcs_temp_table.py @@ -0,0 +1,89 @@ +# 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_query_biglake_gcs_temp_table] +import sys + +from google.api_core import exceptions +from google.cloud import bigquery + + +def query_biglake_gcs_temp_table( + project_id: str, + connection_id: str, +) -> None: + """Configures and queries a temporary BigLake table backed by Cloud Storage. + + Args: + project_id: Google Cloud project ID (for example, 'example-project'). + connection_id: Fully qualified BigQuery Cloud Resource connection ID + (for example, 'projects/example-project/locations/us/connections/example-conn'). + """ + client = bigquery.Client(project=project_id) + temp_table_name = "example_us_states_temp" + source_uri = "gs://cloud-samples-data/bigquery/us-states/us-states.csv" + prefix_filter = "W%" + + # Bind the Cloud Resource connection and explicit schema to a temporary CSV ExternalConfig. + external_config = bigquery.ExternalConfig("CSV") + external_config.source_uris = [source_uri] + external_config.connection_id = connection_id + external_config.schema = [ + bigquery.SchemaField("name", "STRING"), + bigquery.SchemaField("post_abbr", "STRING"), + ] + external_config.csv_options.skip_leading_rows = 1 + + job_config = bigquery.QueryJobConfig( + table_definitions={temp_table_name: external_config}, + query_parameters=[ + bigquery.ScalarQueryParameter("prefix_filter", "STRING", prefix_filter), + ], + ) + sql = f""" + SELECT + name, + post_abbr + FROM `{temp_table_name}` + WHERE post_abbr LIKE @prefix_filter + ORDER BY post_abbr ASC + LIMIT 10; + """ + + try: + print(f"Querying temporary BigLake table {temp_table_name} via {connection_id}") + query_job = client.query(sql, job_config=job_config) + rows = list(query_job.result()) + except exceptions.NotFound as err: + print( + f"error: BigLake connection '{connection_id}' or URI '{source_uri}' " + f"not found in project '{project_id}': {err.message}", + file=sys.stderr, + ) + return + except exceptions.GoogleAPICallError as err: + print( + f"error: failed to query temporary BigLake table via connection " + f"'{connection_id}' in project '{project_id}': {err.message}", + file=sys.stderr, + ) + return + + print(f"Resource ID: {connection_id}") + print(f"Job ID: {query_job.job_id}") + print(f"Rows Returned: {len(rows)}") + print(f"Source URI: {source_uri}") + + +# [END bigquery_query_biglake_gcs_temp_table] diff --git a/bigquery/biglake/bigquery_query_biglake_gcs_temp_table_test.py b/bigquery/biglake/bigquery_query_biglake_gcs_temp_table_test.py new file mode 100644 index 00000000000..0b4c690038c --- /dev/null +++ b/bigquery/biglake/bigquery_query_biglake_gcs_temp_table_test.py @@ -0,0 +1,72 @@ +# 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_query_biglake_gcs_temp_table +from google.api_core import exceptions +import pytest + + +def test_query_biglake_gcs_temp_table_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_query_biglake_gcs_temp_table.bigquery, + "Client", + lambda project=None: mock_client, + ) + + bigquery_query_biglake_gcs_temp_table.query_biglake_gcs_temp_table( + project_id="example-project", + connection_id="projects/example-project/locations/us/connections/example-conn", + ) + + captured = capsys.readouterr() + assert ( + "Resource ID: projects/example-project/locations/us/connections/example-conn" + in captured.out + ) + assert "Rows Returned: 2" in captured.out + assert mock_client.query.called + + +def test_query_biglake_gcs_temp_table_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_query_biglake_gcs_temp_table.bigquery, + "Client", + lambda project=None: mock_client, + ) + + bigquery_query_biglake_gcs_temp_table.query_biglake_gcs_temp_table( + project_id="example-project", + connection_id="projects/example-project/locations/us/connections/example-conn", + ) + + captured = capsys.readouterr() + assert "error:" in captured.err + assert "example-conn" in captured.err diff --git a/bigquery/biglake/noxfile_config.py b/bigquery/biglake/noxfile_config.py new file mode 100644 index 00000000000..63902aa8c7f --- /dev/null +++ b/bigquery/biglake/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/biglake/requirements-test.txt b/bigquery/biglake/requirements-test.txt new file mode 100644 index 00000000000..c9e154ba440 --- /dev/null +++ b/bigquery/biglake/requirements-test.txt @@ -0,0 +1 @@ +pytest==9.0.3; python_version >= "3.10" diff --git a/bigquery/biglake/requirements.txt b/bigquery/biglake/requirements.txt new file mode 100644 index 00000000000..af6312b7e7f --- /dev/null +++ b/bigquery/biglake/requirements.txt @@ -0,0 +1,2 @@ +google-cloud-bigquery==3.47.0 +google-cloud-bigquery-storage==2.43.0