From e5278b2e7018479bc735dd7dad5e849bf6806da1 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Tue, 3 Nov 2026 02:43:56 +0000 Subject: [PATCH] feat(bigquery): add bigquery_create_manifest_biglake_table sample to create a BigLake table backed by a Symfoni/Hive manifest file Problem: The BigQuery documentation (https://cloud.google.com/bigquery/docs/query-open-table-format-using-manifest-files) needs a standalone, tested Python code sample demonstrating how to create a BigLake table backed by a Symfoni/Hive manifest file (region tag `bigquery_create_manifest_biglake_table`). Solution: - Add `create_manifest_biglake_table(project_id: str, dataset_id: str, connection_id: str, manifest_uri: str) -> None` in `bigquery/biglake/bigquery_create_manifest_biglake_table.py` (Create a BigLake external table over open-table-format Parquet files using a manifest file URI and Cloud Resource connection.) - Add unit tests (`bigquery/biglake/bigquery_create_manifest_biglake_table_test.py`) covering both the success path and API error handling (`GoogleAPICallError`) --- .../bigquery_create_manifest_biglake_table.py | 83 +++++++++++++++++++ ...uery_create_manifest_biglake_table_test.py | 66 +++++++++++++++ bigquery/biglake/noxfile_config.py | 23 +++++ bigquery/biglake/requirements-test.txt | 1 + bigquery/biglake/requirements.txt | 2 + 5 files changed, 175 insertions(+) create mode 100644 bigquery/biglake/bigquery_create_manifest_biglake_table.py create mode 100644 bigquery/biglake/bigquery_create_manifest_biglake_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_create_manifest_biglake_table.py b/bigquery/biglake/bigquery_create_manifest_biglake_table.py new file mode 100644 index 00000000000..ec495e9b0a3 --- /dev/null +++ b/bigquery/biglake/bigquery_create_manifest_biglake_table.py @@ -0,0 +1,83 @@ +# 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_create_manifest_biglake_table] +import sys + +from google.api_core import exceptions +from google.cloud import bigquery + + +def create_manifest_biglake_table( + project_id: str, + dataset_id: str, + connection_id: str, + manifest_uri: str, +) -> None: + """Creates a BigLake external table backed by a newline-delimited manifest file. + + Args: + project_id: Google Cloud project ID (for example, 'example-project'). + dataset_id: BigQuery dataset ID where the BigLake table is created + (for example, 'example_dataset'). + connection_id: Fully qualified BigQuery Cloud Resource connection ID + (for example, 'example-project.us.example_biglake_conn'). + manifest_uri: Cloud Storage URI of the SymLinkTextInputFormat manifest file + (for example, 'gs://example-bucket/manifests/symlink.manifest'). + """ + client = bigquery.Client(project=project_id) + # Use a fixed table identifier inside the caller-supplied dataset. + table_id = "example_manifest_biglake_table" + table_ref = f"{project_id}.{dataset_id}.{table_id}" + # Setting file_set_spec_type to NEW_LINE_DELIMITED_MANIFEST tells BigQuery to resolve the + # Parquet data files listed inside the manifest URI via the BigLake connection. + sql = f""" + CREATE OR REPLACE EXTERNAL TABLE `{table_ref}` + WITH CONNECTION `{connection_id}` + OPTIONS ( + format = 'PARQUET', + uris = ['{manifest_uri}'], + file_set_spec_type = 'NEW_LINE_DELIMITED_MANIFEST' + ); + """ + + try: + print(f"Creating manifest-backed BigLake table: {table_ref}") + query_job = client.query(sql) + query_job.result() + except exceptions.NotFound as err: + print( + f"error: dataset '{dataset_id}' or connection '{connection_id}' not found " + f"for project '{project_id}' (manifest '{manifest_uri}'): {err.message}", + file=sys.stderr, + ) + return + except exceptions.GoogleAPICallError as err: + print( + f"error: failed to create BigLake table '{table_id}' in dataset '{dataset_id}' " + f"for project '{project_id}' (connection '{connection_id}', " + f"manifest '{manifest_uri}'): {err.message}", + file=sys.stderr, + ) + return + + print(f"Resource ID: {table_ref}") + print(f"Connection ID: {connection_id}") + print("File Set Spec Type: NEW_LINE_DELIMITED_MANIFEST") + print(f"Job ID: {query_job.job_id}") + print(f"Manifest URI: {manifest_uri}") + print(f"Statement Type: {query_job.statement_type}") + + +# [END bigquery_create_manifest_biglake_table] diff --git a/bigquery/biglake/bigquery_create_manifest_biglake_table_test.py b/bigquery/biglake/bigquery_create_manifest_biglake_table_test.py new file mode 100644 index 00000000000..92d5af69385 --- /dev/null +++ b/bigquery/biglake/bigquery_create_manifest_biglake_table_test.py @@ -0,0 +1,66 @@ +# 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_create_manifest_biglake_table +from google.api_core import exceptions +import pytest + + +def test_create_manifest_biglake_table_success( + capsys: pytest.CaptureFixture[str], +) -> None: + with mock.patch("google.cloud.bigquery.Client") as mock_client_cls: + mock_client = mock_client_cls.return_value + mock_job = mock.MagicMock() + mock_job.job_id = "example-job-123" + mock_job.statement_type = "CREATE_EXTERNAL_TABLE" + mock_job.result.return_value = [] + mock_client.query.return_value = mock_job + + bigquery_create_manifest_biglake_table.create_manifest_biglake_table( + project_id="example-project", + dataset_id="example_dataset", + connection_id="example-project.us.example_biglake_conn", + manifest_uri="gs://example-bucket/manifests/symlink.manifest", + ) + + mock_client.query.assert_called_once() + captured = capsys.readouterr() + assert ( + "Resource ID: example-project.example_dataset.example_manifest_biglake_table" + in captured.out + ) + assert "File Set Spec Type: NEW_LINE_DELIMITED_MANIFEST" in captured.out + assert "Statement Type: CREATE_EXTERNAL_TABLE" in captured.out + + +def test_create_manifest_biglake_table_not_found( + capsys: pytest.CaptureFixture[str], +) -> None: + with mock.patch("google.cloud.bigquery.Client") as mock_client_cls: + mock_client = mock_client_cls.return_value + mock_client.query.side_effect = exceptions.NotFound("Dataset not found") + + bigquery_create_manifest_biglake_table.create_manifest_biglake_table( + project_id="example-project", + dataset_id="example_dataset", + connection_id="example-project.us.example_biglake_conn", + manifest_uri="gs://example-bucket/manifests/symlink.manifest", + ) + + captured = capsys.readouterr() + assert "error:" in captured.err + assert "example_dataset" 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