From 01efd057c4e407ed14485ea3caf67f107df674c6 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Tue, 3 Nov 2026 23:31:51 +0000 Subject: [PATCH] feat(bigquery): add bigquery_create_vector_index sample to create an IVF vector index on embedding column Problem: The BigQuery documentation (https://cloud.google.com/bigquery/docs/vector-index) needs a standalone, tested Python code sample demonstrating how to create an IVF vector index on embedding column (region tag `bigquery_create_vector_index`). Solution: - Add `create_vector_index(project_id: str, dataset_id: str, table_id: str) -> None` in `bigquery/vector_search/bigquery_create_vector_index.py` (Create an inverted file (IVF) vector index on an array embedding column in BigQuery using CREATE OR REPLACE VECTOR INDEX.) - Add unit tests (`bigquery/vector_search/bigquery_create_vector_index_test.py`) covering both the success path and API error handling (`GoogleAPICallError`) --- .../bigquery_create_vector_index.py | 72 +++++++++++++++++++ .../bigquery_create_vector_index_test.py | 72 +++++++++++++++++++ bigquery/vector_search/noxfile_config.py | 23 ++++++ bigquery/vector_search/requirements-test.txt | 1 + bigquery/vector_search/requirements.txt | 1 + 5 files changed, 169 insertions(+) create mode 100644 bigquery/vector_search/bigquery_create_vector_index.py create mode 100644 bigquery/vector_search/bigquery_create_vector_index_test.py create mode 100644 bigquery/vector_search/noxfile_config.py create mode 100644 bigquery/vector_search/requirements-test.txt create mode 100644 bigquery/vector_search/requirements.txt diff --git a/bigquery/vector_search/bigquery_create_vector_index.py b/bigquery/vector_search/bigquery_create_vector_index.py new file mode 100644 index 00000000000..850de8fc73d --- /dev/null +++ b/bigquery/vector_search/bigquery_create_vector_index.py @@ -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. + +# [START bigquery_create_vector_index] +import sys + +from google.api_core import exceptions +from google.cloud import bigquery + + +def create_vector_index( + project_id: str, + dataset_id: str, + table_id: str, +) -> None: + """Creates an IVF vector index on an embedding column in a BigQuery table. + + Args: + project_id: Google Cloud project ID (for example, 'example-project'). + dataset_id: BigQuery dataset ID containing the target table + (for example, 'example_dataset'). + table_id: BigQuery table ID containing the embedding column + (for example, 'example_embeddings'). + """ + client = bigquery.Client(project=project_id) + # Use a fixed vector index name on the caller-supplied embeddings table. + index_name = "example_vector_index" + table_ref = f"{project_id}.{dataset_id}.{table_id}" + # IVF indexes partition vectors into inverted lists to accelerate approximate nearest-neighbor search. + sql = f""" + CREATE OR REPLACE VECTOR INDEX `{index_name}` + ON `{table_ref}`(embedding) + OPTIONS(index_type = 'IVF', distance_type = 'COSINE'); + """ + + try: + print(f"Creating vector index {index_name} on table: {table_ref}") + query_job = client.query(sql) + query_job.result() + except exceptions.NotFound as err: + print( + f"error: table '{table_id}' or dataset '{dataset_id}' not found " + f"for project '{project_id}': {err.message}", + file=sys.stderr, + ) + return + except exceptions.GoogleAPICallError as err: + print( + f"error: failed to create vector index '{index_name}' on table " + f"'{table_id}' in dataset '{dataset_id}' for project '{project_id}': {err.message}", + file=sys.stderr, + ) + return + + print(f"Resource ID: {table_ref}") + print(f"Index Name: {index_name}") + print(f"Job ID: {query_job.job_id}") + print(f"Statement Type: {query_job.statement_type}") + + +# [END bigquery_create_vector_index] diff --git a/bigquery/vector_search/bigquery_create_vector_index_test.py b/bigquery/vector_search/bigquery_create_vector_index_test.py new file mode 100644 index 00000000000..577fec439f3 --- /dev/null +++ b/bigquery/vector_search/bigquery_create_vector_index_test.py @@ -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_create_vector_index +from google.api_core import exceptions +import pytest + + +def test_create_vector_index_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_create_vector_index.bigquery, + "Client", + lambda project=None: mock_client, + ) + + bigquery_create_vector_index.create_vector_index( + project_id="example-project", + dataset_id="example_dataset", + table_id="example_embeddings", + ) + + captured = capsys.readouterr() + assert "Resource ID:" in captured.out + assert "example-project" in captured.out + assert mock_client.query.called + + +def test_create_vector_index_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_create_vector_index.bigquery, + "Client", + lambda project=None: mock_client, + ) + + bigquery_create_vector_index.create_vector_index( + project_id="example-project", + dataset_id="example_dataset", + table_id="example_embeddings", + ) + + captured = capsys.readouterr() + assert "error:" in captured.err + assert "example-project" in captured.err diff --git a/bigquery/vector_search/noxfile_config.py b/bigquery/vector_search/noxfile_config.py new file mode 100644 index 00000000000..63902aa8c7f --- /dev/null +++ b/bigquery/vector_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/vector_search/requirements-test.txt b/bigquery/vector_search/requirements-test.txt new file mode 100644 index 00000000000..c9e154ba440 --- /dev/null +++ b/bigquery/vector_search/requirements-test.txt @@ -0,0 +1 @@ +pytest==9.0.3; python_version >= "3.10" diff --git a/bigquery/vector_search/requirements.txt b/bigquery/vector_search/requirements.txt new file mode 100644 index 00000000000..dc6cf8e4329 --- /dev/null +++ b/bigquery/vector_search/requirements.txt @@ -0,0 +1 @@ +google-cloud-bigquery==3.47.0