From 51ffe3011a254103a7320aef5d8b2c16f998c4be Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Wed, 18 Nov 2026 22:16:09 +0000 Subject: [PATCH 1/3] feat(spanner): Add multi-region default_leader database creation sample Multi-region Spanner databases pin write leadership close to primary application traffic via ALTER DATABASE ... SET OPTIONS (default_leader). Add spanner_create_database_with_default_leader. --- .../create_database_with_default_leader.py | 119 ++++++++++++++ ...reate_database_with_default_leader_test.py | 148 ++++++++++++++++++ 2 files changed, 267 insertions(+) create mode 100644 spanner/database_admin/src/spanner_database_admin/create_database_with_default_leader.py create mode 100644 spanner/database_admin/tests/create_database_with_default_leader_test.py diff --git a/spanner/database_admin/src/spanner_database_admin/create_database_with_default_leader.py b/spanner/database_admin/src/spanner_database_admin/create_database_with_default_leader.py new file mode 100644 index 0000000000..0f522eb508 --- /dev/null +++ b/spanner/database_admin/src/spanner_database_admin/create_database_with_default_leader.py @@ -0,0 +1,119 @@ +# 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_database_with_default_leader] +import sys + +from google.api_core import exceptions +from google.cloud import spanner_admin_database_v1 + + +def create_database_with_default_leader( + project_id: str, instance_id: str, database_id: str, default_leader: str +) -> None: + """Creates a Spanner database configured with an explicit default_leader. + + Args: + project_id: The Google Cloud project ID. + instance_id: The multi-region Spanner instance ID. + database_id: The new Spanner database ID to create. + default_leader: The leader region (for example, 'us-east4'). + """ + client = spanner_admin_database_v1.DatabaseAdminClient() + parent = client.instance_path(project_id, instance_id) + request = spanner_admin_database_v1.CreateDatabaseRequest( + parent=parent, + create_statement=f"CREATE DATABASE `{database_id}`", + extra_statements=[ + "CREATE TABLE Singers (" + " SingerId INT64 NOT NULL," + " FirstName STRING(1024)," + " LastName STRING(1024)," + " SingerInfo BYTES(MAX)" + ") PRIMARY KEY (SingerId)", + "CREATE TABLE Albums (" + " SingerId INT64 NOT NULL," + " AlbumId INT64 NOT NULL," + " AlbumTitle STRING(MAX)" + ") PRIMARY KEY (SingerId, AlbumId)," + " INTERLEAVE IN PARENT Singers ON DELETE CASCADE", + f"ALTER DATABASE `{database_id}` " + f"SET OPTIONS (default_leader = '{default_leader}')", + ], + ) + + try: + operation = client.create_database(request=request) + print( + f"Waiting for database '{database_id}' creation with leader " + f"'{default_leader}'..." + ) + database = operation.result(timeout=300) + except exceptions.AlreadyExists as err: + print( + f"error: database '{database_id}' already exists on instance " + f"'{instance_id}': {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 database '{database_id}' with default " + f"leader '{default_leader}' on instance '{instance_id}': {err.message}", + file=sys.stderr, + ) + else: + print(f"Resource ID: {database_id}") + print(f"Default Leader: {database.default_leader}") + + +# [END spanner_create_database_with_default_leader] + + +if __name__ == "__main__": + import argparse + import os + + parser = argparse.ArgumentParser( + description="Create a Spanner database with an explicit default_leader." + ) + 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-east4"), + ) + args = parser.parse_args() + + create_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/create_database_with_default_leader_test.py b/spanner/database_admin/tests/create_database_with_default_leader_test.py new file mode 100644 index 0000000000..7234ebe164 --- /dev/null +++ b/spanner/database_admin/tests/create_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 . import conftest + +PROJECT_ID = "example-project-id" +INSTANCE_ID = "example-mr-instance" +DATABASE_ID = "example-db" +DEFAULT_LEADER = "us-east4" +ADMIN_CLIENT = "google.cloud.spanner_admin_database_v1.DatabaseAdminClient" + + +@mock.patch(ADMIN_CLIENT) +def test_create_database_with_default_leader_success( + mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str] +) -> None: + mock_client_class.return_value.instance_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}" + ) + db_pb = mock.MagicMock(default_leader=DEFAULT_LEADER) + mock_client_class.return_value.create_database.return_value.result.return_value = ( + db_pb + ) + + create_database_with_default_leader.create_database_with_default_leader( + PROJECT_ID, INSTANCE_ID, DATABASE_ID, DEFAULT_LEADER + ) + + out, err = capsys.readouterr() + assert f"Resource ID: {DATABASE_ID}" in out + assert f"Default Leader: {DEFAULT_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.AlreadyExists("dup"), + "error: database 'example-db' already exists", + ), + ( + exceptions.InvalidArgument("bad leader"), + "error: failed to create database 'example-db' with default leader", + ), + ], +) +@mock.patch(ADMIN_CLIENT) +def test_create_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.instance_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}" + ) + mock_client_class.return_value.create_database.side_effect = error + + create_database_with_default_leader.create_database_with_default_leader( + PROJECT_ID, INSTANCE_ID, DATABASE_ID, DEFAULT_LEADER + ) + + _out, err = capsys.readouterr() + assert err.startswith(expected_prefix) + assert PROJECT_ID not in err + + +@mock.patch(ADMIN_CLIENT) +def test_create_database_with_default_leader_cli_entrypoint( + mock_client_class: mock.MagicMock, + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + mock_client_class.return_value.instance_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}" + ) + db_pb = mock.MagicMock(default_leader=DEFAULT_LEADER) + mock_client_class.return_value.create_database.return_value.result.return_value = ( + db_pb + ) + monkeypatch.setattr( + "sys.argv", + [ + "create_database_with_default_leader.py", + "--project-id", + PROJECT_ID, + "--instance-id", + INSTANCE_ID, + "--database-id", + DATABASE_ID, + "--default-leader", + DEFAULT_LEADER, + ], + ) + + runpy.run_module( + "spanner_database_admin.create_database_with_default_leader", + run_name="__main__", + ) + + assert f"Default Leader: {DEFAULT_LEADER}" in capsys.readouterr().out + + +@conftest.live_only +def test_create_database_with_default_leader_live( + capsys: pytest.CaptureFixture[str], +) -> None: + mr_instance = os.environ["SPANNER_MR_INSTANCE_ID"] + admin = spanner_admin_database_v1.DatabaseAdminClient() + temp_db_id = f"example-ldr-{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" + ) + out, err = capsys.readouterr() + assert err == "" + assert conftest.LIVE_PROJECT_ID not in out + assert "Default Leader: us-east4" in out + finally: + try: + admin.drop_database(database=db_path) + except exceptions.NotFound: + pass From 9508c8f90f546c6818ab80d5125983316c2c9335 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Thu, 19 Nov 2026 04:44:14 +0000 Subject: [PATCH 2/3] style(spanner): use triple-quoted SQL strings in create_database_with_default_leader Problem: multi-line SQL and DDL statements were written as adjacent string fragments. That style is easy to get wrong (a missing trailing space joins two SQL tokens) and is harder to read than the statement itself, and the samples in this set mixed it with triple-quoted SQL. Solution: write each multi-line statement as a single triple-quoted string, matching the layout already used by the other samples. Only whitespace between SQL tokens changes; the statements are otherwise identical. Files updated: - spanner/database_admin/src/spanner_database_admin/create_database_with_default_leader.py --- .../create_database_with_default_leader.py | 34 +++++++++++-------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/spanner/database_admin/src/spanner_database_admin/create_database_with_default_leader.py b/spanner/database_admin/src/spanner_database_admin/create_database_with_default_leader.py index 0f522eb508..719827a07b 100644 --- a/spanner/database_admin/src/spanner_database_admin/create_database_with_default_leader.py +++ b/spanner/database_admin/src/spanner_database_admin/create_database_with_default_leader.py @@ -36,20 +36,26 @@ def create_database_with_default_leader( parent=parent, create_statement=f"CREATE DATABASE `{database_id}`", extra_statements=[ - "CREATE TABLE Singers (" - " SingerId INT64 NOT NULL," - " FirstName STRING(1024)," - " LastName STRING(1024)," - " SingerInfo BYTES(MAX)" - ") PRIMARY KEY (SingerId)", - "CREATE TABLE Albums (" - " SingerId INT64 NOT NULL," - " AlbumId INT64 NOT NULL," - " AlbumTitle STRING(MAX)" - ") PRIMARY KEY (SingerId, AlbumId)," - " INTERLEAVE IN PARENT Singers ON DELETE CASCADE", - f"ALTER DATABASE `{database_id}` " - f"SET OPTIONS (default_leader = '{default_leader}')", + """ + CREATE TABLE Singers ( + SingerId INT64 NOT NULL, + FirstName STRING(1024), + LastName STRING(1024), + SingerInfo BYTES(MAX) + ) PRIMARY KEY (SingerId) + """, + """ + CREATE TABLE Albums ( + SingerId INT64 NOT NULL, + AlbumId INT64 NOT NULL, + AlbumTitle STRING(MAX) + ) PRIMARY KEY (SingerId, AlbumId), + INTERLEAVE IN PARENT Singers ON DELETE CASCADE + """, + f""" + ALTER DATABASE `{database_id}` + SET OPTIONS (default_leader = '{default_leader}') + """, ], ) From eb1a8fab54ca0168fac117139792e27d455bb4a9 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Thu, 19 Nov 2026 06:19:37 +0000 Subject: [PATCH 3/3] fix(spanner): address review feedback for create_database_with_default_leader Problem: review of this sample identified correctness and robustness improvements in the sample and its tests. Solution: apply the accepted review suggestions and extend the tests to cover the updated behavior. Details are in the review thread replies. Files updated: - spanner/database_admin/tests/create_database_with_default_leader_test.py --- .../tests/create_database_with_default_leader_test.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/spanner/database_admin/tests/create_database_with_default_leader_test.py b/spanner/database_admin/tests/create_database_with_default_leader_test.py index 7234ebe164..bc8f00483f 100644 --- a/spanner/database_admin/tests/create_database_with_default_leader_test.py +++ b/spanner/database_admin/tests/create_database_with_default_leader_test.py @@ -129,6 +129,10 @@ def test_create_database_with_default_leader_cli_entrypoint( def test_create_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-ldr-{uuid.uuid4().hex[:6]}"