Skip to content

feat(bigquery): add bigquery_update_search_index sample to update col… - #14745

Open
iennae wants to merge 1 commit into
mainfrom
feat/bq-update-search-index
Open

iennae wants to merge 1 commit into
mainfrom
feat/bq-update-search-index

Conversation

@iennae

@iennae iennae commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

…umns in an existing search index

Problem:
The BigQuery documentation (https://cloud.google.com/bigquery/docs/search-index) needs a standalone, tested Python code sample demonstrating how to update columns in an existing search index (region tag bigquery_update_search_index).

Solution:

  • Add update_search_index(project_id: str, dataset_id: str, table_id: str) -> None in bigquery/search/bigquery_update_search_index.py (Modify an existing BigQuery search index using ALTER SEARCH INDEX ... ADD COLUMNS / DROP COLUMNS.)
  • Add unit tests (bigquery/search/bigquery_update_search_index_test.py) covering both the success path and API error handling (GoogleAPICallError)

Description

Fixes #

Checklist

Testing

  • I have tested this change on a live environment and verified it works as intended.

Compliance & Style


Post-Approval Actions

  • Please merge this PR for me once it is approved

@iennae
iennae requested review from a team and chalmerlowe as code owners November 2, 2026 23:24
@snippet-bot

snippet-bot Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Here is the summary of changes.

You are about to add 1 region tag.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@product-auto-label product-auto-label Bot added api: bigquery Issues related to the BigQuery API. samples Issues that are directly related to samples. labels Nov 2, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new Python script and unit tests to update a BigQuery search index by dropping a column using the ALTER SEARCH INDEX statement. It also includes the necessary configuration and requirements files. The review feedback suggests correcting the ignored Python versions in noxfile_config.py to ensure that only the oldest and newest supported Python releases are tested, aligning with the testing guidelines.


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"],

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

According to the testing guidelines, we should only test the oldest and newest supported Python releases in test configurations, ignoring intermediate versions. Since Python 3.10 is the oldest supported version (as indicated by requirements-test.txt), it should not be ignored. Intermediate versions like 3.11 and 3.12 should be ignored instead.

Suggested change
"ignored_versions": ["2.7", "3.7", "3.8", "3.9", "3.10", "3.11"],
"ignored_versions": ["2.7", "3.7", "3.8", "3.9", "3.11", "3.12"],
References
  1. Only test the oldest and newest supported Python releases in test configurations (such as noxfile_config.py), ignoring intermediate versions.

@iennae
iennae force-pushed the feat/bq-update-search-index branch 2 times, most recently from 497ee78 to f14a90f Compare November 3, 2026 02:44
…umns in an existing search index

Problem:
The BigQuery documentation (https://cloud.google.com/bigquery/docs/search-index)
needs a standalone, tested Python code sample demonstrating how to
update columns in an existing search index (region tag `bigquery_update_search_index`).

Solution:
- Add `update_search_index(project_id: str, dataset_id: str, table_id: str) -> None` in `bigquery/search/bigquery_update_search_index.py`
  (Modify an existing BigQuery search index using ALTER SEARCH INDEX ... ADD COLUMNS / DROP COLUMNS.)
- Add unit tests (`bigquery/search/bigquery_update_search_index_test.py`) covering both the success
  path and API error handling (`GoogleAPICallError`)
@iennae
iennae force-pushed the feat/bq-update-search-index branch from f14a90f to dbca00d Compare November 3, 2026 23:32

@XrossFox XrossFox left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: bigquery Issues related to the BigQuery API. samples Issues that are directly related to samples.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants