feat(bigquery): add bigquery_call_system_procedure sample to call a b…

bigquery/stored_procedures/bigquery_call_system_procedure.py

@@ -0,0 +1,71 @@
+# 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_call_system_procedure]
+import sys
+
+from google.api_core import exceptions
+from google.cloud import bigquery
+
+
+def call_system_procedure(
+    project_id: str,
+    dataset_id: str,
+    materialized_view_id: str,
+) -> None:
+    """Calls the BQ.REFRESH_MATERIALIZED_VIEW system procedure with a query parameter.
+
+    Args:
+        project_id: Google Cloud project ID (for example, 'example-project').
+        dataset_id: BigQuery dataset ID containing the materialized view
+            (for example, 'example_dataset').
+        materialized_view_id: Materialized view ID to refresh
+            (for example, 'example_mv').
+    """
+    client = bigquery.Client(project=project_id)
+    mv_ref = f"{project_id}.{dataset_id}.{materialized_view_id}"
+    # Pass the target materialized view identifier via a query parameter to BQ.REFRESH_MATERIALIZED_VIEW.
+    job_config = bigquery.QueryJobConfig(
+        query_parameters=[
+            bigquery.ScalarQueryParameter("view_name", "STRING", mv_ref),
+        ]
+    )
+    sql = "CALL BQ.REFRESH_MATERIALIZED_VIEW(@view_name);"
+
+    try:
+        print(f"Refreshing materialized view via system procedure: {mv_ref}")
+        query_job = client.query(sql, job_config=job_config)
+        query_job.result()
+    except exceptions.NotFound as err:
+        print(
+            f"error: materialized view '{materialized_view_id}' not found in dataset "
+            f"'{dataset_id}' for project '{project_id}': {err.message}",
+            file=sys.stderr,
+        )
+        return
+    except exceptions.GoogleAPICallError as err:
+        print(
+            f"error: failed to refresh materialized view '{materialized_view_id}' in dataset "
+            f"'{dataset_id}' for project '{project_id}': {err.message}",
+            file=sys.stderr,
+        )
+        return
+
+    print(f"Resource ID: {mv_ref}")
+    print(f"Job ID: {query_job.job_id}")
+    print(f"Statement Type: {query_job.statement_type}")
+    print("System Procedure: BQ.REFRESH_MATERIALIZED_VIEW")
+
+
+# [END bigquery_call_system_procedure]

bigquery/stored_procedures/bigquery_call_system_procedure_test.py

@@ -0,0 +1,63 @@
+# 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_call_system_procedure
+from google.api_core import exceptions
+import pytest
+
+
+def test_call_system_procedure_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 = "SCRIPT"
+        mock_job.result.return_value = []
+        mock_client.query.return_value = mock_job
+
+        bigquery_call_system_procedure.call_system_procedure(
+            project_id="example-project",
+            dataset_id="example_dataset",
+            materialized_view_id="example_mv",
+        )
+
+        mock_client.query.assert_called_once()
+        captured = capsys.readouterr()
+        assert "Resource ID: example-project.example_dataset.example_mv" in captured.out
+        assert "Statement Type: SCRIPT" in captured.out
+        assert "System Procedure: BQ.REFRESH_MATERIALIZED_VIEW" in captured.out
+
+
+def test_call_system_procedure_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_job = mock.MagicMock()
+        mock_job.result.side_effect = exceptions.NotFound("View not found")
+        mock_client.query.return_value = mock_job
+
+        bigquery_call_system_procedure.call_system_procedure(
+            project_id="example-project",
+            dataset_id="example_dataset",
+            materialized_view_id="example_mv",
+        )
+
+        captured = capsys.readouterr()
+        assert "error:" in captured.err
+        assert "example_mv" in captured.err

bigquery/stored_procedures/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": {},
+}

bigquery/stored_procedures/requirements-test.txt

@@ -0,0 +1 @@
+pytest==9.0.3; python_version >= "3.10"

bigquery/stored_procedures/requirements.txt

@@ -0,0 +1 @@
+google-cloud-bigquery==3.47.0