diff --git a/spanner/database_admin/src/spanner_database_admin/create_index.py b/spanner/database_admin/src/spanner_database_admin/create_index.py new file mode 100644 index 0000000000..2836fc2941 --- /dev/null +++ b/spanner/database_admin/src/spanner_database_admin/create_index.py @@ -0,0 +1,97 @@ +# 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 +# +# http://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 spanner_create_index] +import sys + +from google.api_core import exceptions +from google.cloud import spanner_admin_database_v1 + + +def create_index(project_id: str, instance_id: str, database_id: str) -> None: + """Creates a secondary index on Albums(AlbumTitle) online via DDL. + + Args: + project_id: The Google Cloud project ID. + instance_id: The Spanner instance ID. + database_id: The Spanner database ID containing Albums. + """ + client = spanner_admin_database_v1.DatabaseAdminClient() + database_path = client.database_path(project_id, instance_id, database_id) + index_name = "AlbumsByAlbumTitle" + request = spanner_admin_database_v1.UpdateDatabaseDdlRequest( + database=database_path, + statements=[f"CREATE INDEX {index_name} ON Albums(AlbumTitle)"], + ) + + try: + operation = client.update_database_ddl(request=request) + print(f"Waiting for secondary index '{index_name}' creation...") + operation.result(timeout=300) + except (exceptions.AlreadyExists, exceptions.FailedPrecondition) as err: + print( + f"error: index '{index_name}' already exists or preconditions " + f"failed on database '{database_id}' in instance '{instance_id}': " + f"{err.message}", + file=sys.stderr, + ) + except TimeoutError as err: + print( + f"error: timed out waiting for the operation on database '{database_id}' " + f"to complete; the operation may still be running: {err}", + file=sys.stderr, + ) + except exceptions.GoogleAPICallError as err: + print( + f"error: failed to create index '{index_name}' on database " + f"'{database_id}' in instance '{instance_id}': {err.message}", + file=sys.stderr, + ) + else: + print(f"Resource ID: {database_id}") + print(f"Index Name: {index_name}") + + +# [END spanner_create_index] + + +if __name__ == "__main__": + import argparse + import os + + parser = argparse.ArgumentParser( + description="Create a secondary index on Albums(AlbumTitle)." + ) + parser.add_argument( + "--project-id", + default=os.environ.get("GOOGLE_CLOUD_PROJECT", "example-project-id"), + help="Google Cloud project ID (default: $GOOGLE_CLOUD_PROJECT)", + ) + parser.add_argument( + "--instance-id", + default=os.environ.get("SPANNER_INSTANCE_ID", "example-instance"), + help="Spanner instance ID (default: $SPANNER_INSTANCE_ID)", + ) + parser.add_argument( + "--database-id", + default=os.environ.get("SPANNER_DATABASE_ID", "example-db"), + help="Spanner database ID (default: $SPANNER_DATABASE_ID)", + ) + args = parser.parse_args() + + create_index( + project_id=args.project_id, + instance_id=args.instance_id, + database_id=args.database_id, + ) diff --git a/spanner/database_admin/tests/create_index_test.py b/spanner/database_admin/tests/create_index_test.py new file mode 100644 index 0000000000..9f416b7f53 --- /dev/null +++ b/spanner/database_admin/tests/create_index_test.py @@ -0,0 +1,133 @@ +# 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 +# +# http://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. + +import runpy +from unittest import mock +import uuid + +from google.api_core import exceptions +from google.cloud import spanner_admin_database_v1 +import pytest +from spanner_database_admin import create_database +from spanner_database_admin import create_index + +from . import conftest + +PROJECT_ID = "example-project-id" +INSTANCE_ID = "example-instance" +DATABASE_ID = "example-db" +ADMIN_CLIENT = "google.cloud.spanner_admin_database_v1.DatabaseAdminClient" + + +@mock.patch(ADMIN_CLIENT) +def test_create_index_success( + mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str] +) -> None: + mock_client_class.return_value.database_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" + ) + + create_index.create_index(PROJECT_ID, INSTANCE_ID, DATABASE_ID) + + out, err = capsys.readouterr() + assert f"Resource ID: {DATABASE_ID}" in out + assert "Index Name: AlbumsByAlbumTitle" in out + assert PROJECT_ID not in out + assert err == "" + + +@pytest.mark.parametrize( + "error, expected_prefix", + [ + (TimeoutError("deadline"), "error: timed out waiting for the operation"), + ( + exceptions.FailedPrecondition("exists"), + "error: index 'AlbumsByAlbumTitle' already exists", + ), + ( + exceptions.PermissionDenied("denied"), + "error: failed to create index 'AlbumsByAlbumTitle'", + ), + ], +) +@mock.patch(ADMIN_CLIENT) +def test_create_index_errors( + mock_client_class: mock.MagicMock, + capsys: pytest.CaptureFixture[str], + error: Exception, + expected_prefix: str, +) -> None: + mock_client_class.return_value.database_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" + ) + mock_client_class.return_value.update_database_ddl.side_effect = error + + create_index.create_index(PROJECT_ID, INSTANCE_ID, DATABASE_ID) + + _out, err = capsys.readouterr() + assert err.startswith(expected_prefix) + assert PROJECT_ID not in err + + +@mock.patch(ADMIN_CLIENT) +def test_create_index_cli_entrypoint( + mock_client_class: mock.MagicMock, + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + mock_client_class.return_value.database_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" + ) + monkeypatch.setattr( + "sys.argv", + [ + "create_index.py", + "--project-id", + PROJECT_ID, + "--instance-id", + INSTANCE_ID, + "--database-id", + DATABASE_ID, + ], + ) + + runpy.run_module("spanner_database_admin.create_index", run_name="__main__") + + assert "Index Name: AlbumsByAlbumTitle" in capsys.readouterr().out + + +@conftest.live_only +def test_create_index_live(capsys: pytest.CaptureFixture[str]) -> None: + admin = spanner_admin_database_v1.DatabaseAdminClient() + temp_db_id = f"example-idx-{uuid.uuid4().hex[:6]}" + db_path = admin.database_path( + conftest.LIVE_PROJECT_ID, conftest.LIVE_INSTANCE_ID, temp_db_id + ) + try: + create_database.create_database( + conftest.LIVE_PROJECT_ID, conftest.LIVE_INSTANCE_ID, temp_db_id + ) + capsys.readouterr() + create_index.create_index( + conftest.LIVE_PROJECT_ID, conftest.LIVE_INSTANCE_ID, temp_db_id + ) + out, err = capsys.readouterr() + assert err == "" + assert conftest.LIVE_PROJECT_ID not in out + assert "Index Name: AlbumsByAlbumTitle" in out + finally: + try: + admin.drop_database(database=db_path) + except exceptions.NotFound: + pass