Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions bigquery/biglake/bigquery_query_biglake_gcs_temp_table.py
Original file line number Diff line number Diff line change
@@ -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]
72 changes: 72 additions & 0 deletions bigquery/biglake/bigquery_query_biglake_gcs_temp_table_test.py
Original file line number Diff line number Diff line change
@@ -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
23 changes: 23 additions & 0 deletions bigquery/biglake/noxfile_config.py
Original file line number Diff line number Diff line change
@@ -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": {},
}
1 change: 1 addition & 0 deletions bigquery/biglake/requirements-test.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pytest==9.0.3; python_version >= "3.10"
2 changes: 2 additions & 0 deletions bigquery/biglake/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
google-cloud-bigquery==3.47.0
google-cloud-bigquery-storage==2.43.0
Loading