Repository navigation
feat(bigquery): add bigquery_drop_procedure sample to drop a SQL stor… #14734
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
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,64 @@ | ||
| # 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_drop_procedure] | ||
| import sys | ||
|
|
||
| from google.api_core import exceptions | ||
| from google.cloud import bigquery | ||
|
|
||
|
|
||
| def drop_procedure( | ||
| project_id: str, | ||
| dataset_id: str, | ||
| procedure_id: str, | ||
| ) -> None: | ||
| """Drops a GoogleSQL stored procedure from a BigQuery dataset. | ||
|
|
||
| Args: | ||
| project_id: Google Cloud project ID (for example, 'example-project'). | ||
| dataset_id: BigQuery dataset ID containing the stored procedure | ||
| (for example, 'example_dataset'). | ||
| procedure_id: Stored procedure ID to drop | ||
| (for example, 'example_procedure'). | ||
| """ | ||
| client = bigquery.Client(project=project_id) | ||
| routine_ref = f"{project_id}.{dataset_id}.{procedure_id}" | ||
| # Use IF EXISTS so dropping an already-removed routine succeeds idempotently. | ||
| sql = f"DROP PROCEDURE IF EXISTS `{routine_ref}`;" | ||
|
|
||
| try: | ||
| print(f"Dropping stored procedure: {routine_ref}") | ||
| query_job = client.query(sql) | ||
| query_job.result() | ||
| except exceptions.NotFound as err: | ||
| print( | ||
| f"error: dataset '{dataset_id}' or project '{project_id}' not found: {err.message}", | ||
| file=sys.stderr, | ||
| ) | ||
| return | ||
| except exceptions.GoogleAPICallError as err: | ||
| print( | ||
| f"error: failed to drop stored procedure '{procedure_id}' in dataset " | ||
| f"'{dataset_id}' for project '{project_id}': {err.message}", | ||
| file=sys.stderr, | ||
| ) | ||
| return | ||
|
|
||
| print(f"Resource ID: {routine_ref}") | ||
| print(f"Job ID: {query_job.job_id}") | ||
| print(f"Statement Type: {query_job.statement_type}") | ||
|
|
||
|
|
||
| # [END bigquery_drop_procedure] | ||
72 changes: 72 additions & 0 deletions
72
bigquery/stored_procedures/bigquery_drop_procedure_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,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_drop_procedure | ||
| from google.api_core import exceptions | ||
| import pytest | ||
|
|
||
|
|
||
| def test_drop_procedure_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.statement_type = "SCRIPT" | ||
| mock_job.result.return_value = [] | ||
| mock_client.query.return_value = mock_job | ||
| monkeypatch.setattr( | ||
| bigquery_drop_procedure.bigquery, | ||
| "Client", | ||
| lambda project=None: mock_client, | ||
| ) | ||
|
|
||
| bigquery_drop_procedure.drop_procedure( | ||
| project_id="example-project", | ||
| dataset_id="example_dataset", | ||
| procedure_id="example_procedure", | ||
| ) | ||
|
|
||
| captured = capsys.readouterr() | ||
| assert "Resource ID:" in captured.out | ||
| assert "example-project" in captured.out | ||
| assert mock_client.query.called | ||
|
|
||
|
|
||
| def test_drop_procedure_error( | ||
| monkeypatch: pytest.MonkeyPatch, | ||
| capsys: pytest.CaptureFixture[str], | ||
| ) -> None: | ||
| mock_client = mock.MagicMock() | ||
| mock_job = mock.MagicMock() | ||
| mock_job.result.side_effect = exceptions.NotFound("resource error") | ||
| mock_client.query.return_value = mock_job | ||
| monkeypatch.setattr( | ||
| bigquery_drop_procedure.bigquery, | ||
| "Client", | ||
| lambda project=None: mock_client, | ||
| ) | ||
|
|
||
| bigquery_drop_procedure.drop_procedure( | ||
| project_id="example-project", | ||
| dataset_id="example_dataset", | ||
| procedure_id="example_procedure", | ||
| ) | ||
|
|
||
| captured = capsys.readouterr() | ||
| assert "error:" in captured.err | ||
| assert "example-project" 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 @@ | ||
| google-cloud-bigquery==3.47.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.