Repository navigation
feat(bigquery): add bigquery_create_manifest_biglake_table sample to … #14721
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
Merged
Merged
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
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
83 changes: 83 additions & 0 deletions
83
bigquery/biglake/bigquery_create_manifest_biglake_table.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,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] | ||
66 changes: 66 additions & 0 deletions
66
bigquery/biglake/bigquery_create_manifest_biglake_table_test.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,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 |
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,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": {}, | ||
| } |
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 @@ | ||
| pytest==9.0.3; python_version >= "3.10" |
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,2 @@ | ||
| google-cloud-bigquery==3.47.0 | ||
| google-cloud-bigquery-storage==2.43.0 |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.