From 50a8bece5d50bf3f502f4241393949348d3cecbd Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Tue, 3 Nov 2026 02:43:53 +0000 Subject: [PATCH] feat(bigquery): add bigquery_search_with_analyzer_options sample to search text with custom JSON analyzer options Problem: The BigQuery documentation (https://cloud.google.com/bigquery/docs/search) needs a standalone, tested Python code sample demonstrating how to search text with custom JSON analyzer options (region tag `bigquery_search_with_analyzer_options`). Solution: - Add `search_with_analyzer_options(project_id: str) -> None` in `bigquery/search/bigquery_search_with_analyzer_options.py` (Run a BigQuery SEARCH query configured with custom JSON analyzer_options such as token_filters and stop_words.) - Add unit tests (`bigquery/search/bigquery_search_with_analyzer_options_test.py`) covering both the success path and API error handling (`GoogleAPICallError`) --- .../bigquery_search_with_analyzer_options.py | 86 +++++++++++++++++++ ...query_search_with_analyzer_options_test.py | 66 ++++++++++++++ bigquery/search/noxfile_config.py | 23 +++++ bigquery/search/requirements-test.txt | 1 + bigquery/search/requirements.txt | 1 + 5 files changed, 177 insertions(+) create mode 100644 bigquery/search/bigquery_search_with_analyzer_options.py create mode 100644 bigquery/search/bigquery_search_with_analyzer_options_test.py create mode 100644 bigquery/search/noxfile_config.py create mode 100644 bigquery/search/requirements-test.txt create mode 100644 bigquery/search/requirements.txt diff --git a/bigquery/search/bigquery_search_with_analyzer_options.py b/bigquery/search/bigquery_search_with_analyzer_options.py new file mode 100644 index 00000000000..178e9a54f3c --- /dev/null +++ b/bigquery/search/bigquery_search_with_analyzer_options.py @@ -0,0 +1,86 @@ +# 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_search_with_analyzer_options] +import sys + +from google.api_core import exceptions +from google.cloud import bigquery + + +def search_with_analyzer_options( + project_id: str, +) -> None: + """Searches a BigQuery table using custom JSON analyzer_options in SEARCH. + + Args: + project_id: Google Cloud project ID used to bill the query job + (for example, 'example-project'). + """ + client = bigquery.Client(project=project_id) + # Query the public theLook eCommerce dataset in bigquery-public-data + # (https://cloud.google.com/bigquery/public-data). + table_ref = "bigquery-public-data.thelook_ecommerce.users" + # Configure LOG_ANALYZER with a custom stop_words filter so 'Apt' is ignored during token matching. + search_query = "Nelson Apt" + job_config = bigquery.QueryJobConfig( + query_parameters=[ + bigquery.ScalarQueryParameter("search_query", "STRING", search_query), + ] + ) + sql = f""" + SELECT + u.id, + u.first_name, + u.last_name, + u.street_address + FROM `{table_ref}` AS u + WHERE SEARCH( + u.street_address, + @search_query, + analyzer => 'LOG_ANALYZER', + analyzer_options => '{{"token_filters": [{{"stop_words": ["Apt"]}}]}}' + ) + ORDER BY u.id ASC + LIMIT 10; + """ + + try: + print( + f"Searching {table_ref} with custom stop-word analyzer_options for: {search_query}" + ) + query_job = client.query(sql, job_config=job_config) + rows = list(query_job.result()) + except exceptions.NotFound as err: + print( + f"error: table '{table_ref}' not found when querying from project " + f"'{project_id}': {err.message}", + file=sys.stderr, + ) + return + except exceptions.GoogleAPICallError as err: + print( + f"error: failed to search '{table_ref}' with analyzer_options in project " + f"'{project_id}': {err.message}", + file=sys.stderr, + ) + return + + print(f"Resource ID: {table_ref}") + print("Analyzer: LOG_ANALYZER") + print(f"Job ID: {query_job.job_id}") + print(f"Matching Rows: {len(rows)}") + + +# [END bigquery_search_with_analyzer_options] diff --git a/bigquery/search/bigquery_search_with_analyzer_options_test.py b/bigquery/search/bigquery_search_with_analyzer_options_test.py new file mode 100644 index 00000000000..7d69d794902 --- /dev/null +++ b/bigquery/search/bigquery_search_with_analyzer_options_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_search_with_analyzer_options +from google.api_core import exceptions +import pytest + + +def test_search_with_analyzer_options_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_client.query.return_value = mock_job + monkeypatch.setattr( + bigquery_search_with_analyzer_options.bigquery, + "Client", + lambda project=None: mock_client, + ) + + bigquery_search_with_analyzer_options.search_with_analyzer_options( + project_id="example-project", + ) + + captured = capsys.readouterr() + assert "Resource ID: bigquery-public-data.thelook_ecommerce.users" in captured.out + assert "Analyzer: LOG_ANALYZER" in captured.out + assert "Matching Rows: 1" in captured.out + assert mock_client.query.called + + +def test_search_with_analyzer_options_error( + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + mock_client = mock.MagicMock() + mock_client.query.side_effect = exceptions.NotFound("resource error") + monkeypatch.setattr( + bigquery_search_with_analyzer_options.bigquery, + "Client", + lambda project=None: mock_client, + ) + + bigquery_search_with_analyzer_options.search_with_analyzer_options( + project_id="example-project", + ) + + captured = capsys.readouterr() + assert "error:" in captured.err + assert "example-project" in captured.err diff --git a/bigquery/search/noxfile_config.py b/bigquery/search/noxfile_config.py new file mode 100644 index 00000000000..63902aa8c7f --- /dev/null +++ b/bigquery/search/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/search/requirements-test.txt b/bigquery/search/requirements-test.txt new file mode 100644 index 00000000000..c9e154ba440 --- /dev/null +++ b/bigquery/search/requirements-test.txt @@ -0,0 +1 @@ +pytest==9.0.3; python_version >= "3.10" diff --git a/bigquery/search/requirements.txt b/bigquery/search/requirements.txt new file mode 100644 index 00000000000..dc6cf8e4329 --- /dev/null +++ b/bigquery/search/requirements.txt @@ -0,0 +1 @@ +google-cloud-bigquery==3.47.0