diff --git a/spanner/database_admin/src/spanner_database_admin/update_database_with_default_leader.py b/spanner/database_admin/src/spanner_database_admin/update_database_with_default_leader.py new file mode 100644 index 0000000000..ff5ba748fd --- /dev/null +++ b/spanner/database_admin/src/spanner_database_admin/update_database_with_default_leader.py @@ -0,0 +1,107 @@ +# 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_update_database_with_default_leader] +import sys + +from google.api_core import exceptions +from google.cloud import spanner_admin_database_v1 + + +def update_database_with_default_leader( + project_id: str, instance_id: str, database_id: str, default_leader: str +) -> None: + """Updates the default_leader database option via ALTER DATABASE DDL. + + Args: + project_id: The Google Cloud project ID. + instance_id: The multi-region Spanner instance ID. + database_id: The Spanner database ID. + default_leader: The target leader region (for example, 'us-central1'). + """ + client = spanner_admin_database_v1.DatabaseAdminClient() + database_path = client.database_path(project_id, instance_id, database_id) + request = spanner_admin_database_v1.UpdateDatabaseDdlRequest( + database=database_path, + statements=[f""" + ALTER DATABASE `{database_id}` + SET OPTIONS (default_leader = '{default_leader}') + """], + ) + + try: + operation = client.update_database_ddl(request=request) + print( + f"Waiting for default_leader update to '{default_leader}' on " + f"'{database_id}'..." + ) + operation.result(timeout=300) + updated_db = client.get_database(name=database_path) + except exceptions.NotFound as err: + print( + f"error: database '{database_id}' on instance '{instance_id}' " + f"was not found: {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 update default_leader on database " + f"'{database_id}' in instance '{instance_id}': {err.message}", + file=sys.stderr, + ) + else: + print(f"Resource ID: {database_id}") + print(f"Default Leader: {updated_db.default_leader}") + + +# [END spanner_update_database_with_default_leader] + + +if __name__ == "__main__": + import argparse + import os + + parser = argparse.ArgumentParser( + description="Update the default_leader option on a Spanner database." + ) + parser.add_argument( + "--project-id", + default=os.environ.get("GOOGLE_CLOUD_PROJECT", "example-project-id"), + ) + parser.add_argument( + "--instance-id", + default=os.environ.get("SPANNER_MR_INSTANCE_ID", "example-mr-instance"), + ) + parser.add_argument( + "--database-id", + default=os.environ.get("SPANNER_DATABASE_ID", "example-db"), + ) + parser.add_argument( + "--default-leader", + default=os.environ.get("SPANNER_DEFAULT_LEADER", "us-central1"), + ) + args = parser.parse_args() + + update_database_with_default_leader( + project_id=args.project_id, + instance_id=args.instance_id, + database_id=args.database_id, + default_leader=args.default_leader, + ) diff --git a/spanner/database_admin/tests/update_database_with_default_leader_test.py b/spanner/database_admin/tests/update_database_with_default_leader_test.py new file mode 100644 index 0000000000..11d42649e7 --- /dev/null +++ b/spanner/database_admin/tests/update_database_with_default_leader_test.py @@ -0,0 +1,148 @@ +# 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 os +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_with_default_leader +from spanner_database_admin import update_database_with_default_leader + +from . import conftest + +PROJECT_ID = "example-project-id" +INSTANCE_ID = "example-mr-instance" +DATABASE_ID = "example-db" +LEADER = "us-central1" +ADMIN_CLIENT = "google.cloud.spanner_admin_database_v1.DatabaseAdminClient" + + +@mock.patch(ADMIN_CLIENT) +def test_update_database_with_default_leader_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}" + ) + mock_client_class.return_value.get_database.return_value.default_leader = LEADER + + update_database_with_default_leader.update_database_with_default_leader( + PROJECT_ID, INSTANCE_ID, DATABASE_ID, LEADER + ) + + out, err = capsys.readouterr() + assert f"Resource ID: {DATABASE_ID}" in out + assert f"Default Leader: {LEADER}" 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.NotFound("missing"), "error: database 'example-db'"), + ( + exceptions.InvalidArgument("bad leader"), + "error: failed to update default_leader", + ), + ], +) +@mock.patch(ADMIN_CLIENT) +def test_update_database_with_default_leader_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 + + update_database_with_default_leader.update_database_with_default_leader( + PROJECT_ID, INSTANCE_ID, DATABASE_ID, LEADER + ) + + _out, err = capsys.readouterr() + assert err.startswith(expected_prefix) + assert PROJECT_ID not in err + + +@mock.patch(ADMIN_CLIENT) +def test_update_database_with_default_leader_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}" + ) + mock_client_class.return_value.get_database.return_value.default_leader = LEADER + monkeypatch.setattr( + "sys.argv", + [ + "update_database_with_default_leader.py", + "--project-id", + PROJECT_ID, + "--instance-id", + INSTANCE_ID, + "--database-id", + DATABASE_ID, + "--default-leader", + LEADER, + ], + ) + + runpy.run_module( + "spanner_database_admin.update_database_with_default_leader", + run_name="__main__", + ) + + assert f"Default Leader: {LEADER}" in capsys.readouterr().out + + +@conftest.live_only +def test_update_database_with_default_leader_live( + capsys: pytest.CaptureFixture[str], +) -> None: + required = ("SPANNER_MR_INSTANCE_ID",) + missing = [name for name in required if not os.environ.get(name)] + if missing: + pytest.skip(f"Set {', '.join(missing)} to run this live test.") + mr_instance = os.environ["SPANNER_MR_INSTANCE_ID"] + admin = spanner_admin_database_v1.DatabaseAdminClient() + temp_db_id = f"example-uld-{uuid.uuid4().hex[:6]}" + db_path = admin.database_path(conftest.LIVE_PROJECT_ID, mr_instance, temp_db_id) + try: + create_database_with_default_leader.create_database_with_default_leader( + conftest.LIVE_PROJECT_ID, mr_instance, temp_db_id, "us-east4" + ) + capsys.readouterr() + update_database_with_default_leader.update_database_with_default_leader( + conftest.LIVE_PROJECT_ID, mr_instance, temp_db_id, "us-east1" + ) + out, err = capsys.readouterr() + assert err == "" + assert conftest.LIVE_PROJECT_ID not in out + assert "Default Leader: us-east1" in out + finally: + try: + admin.drop_database(database=db_path) + except exceptions.NotFound: + pass