From ebd26f433c406f8ba211547c5675248f4fc812b5 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Wed, 18 Nov 2026 04:51:09 +0000 Subject: [PATCH 1/3] feat(spanner): Add PostgreSQL ALTER SEQUENCE SKIP RANGE sample Migrating existing integer IDs into a PostgreSQL-dialect table skips reserved ranges on a bit-reversed sequence via ALTER SEQUENCE ... SKIP RANGE. Add spanner_postgresql_alter_sequence. --- .../postgresql_alter_sequence.py | 110 ++++++++++ .../tests/postgresql_alter_sequence_test.py | 188 ++++++++++++++++++ 2 files changed, 298 insertions(+) create mode 100644 spanner/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py create mode 100644 spanner/postgresql/tests/postgresql_alter_sequence_test.py diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py b/spanner/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py new file mode 100644 index 0000000000..ee56aa5b9f --- /dev/null +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py @@ -0,0 +1,110 @@ +# 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_postgresql_alter_sequence] +import sys + +from google.api_core import exceptions +from google.cloud import spanner +from google.cloud import spanner_admin_database_v1 +from google.cloud import spanner_v1 + + +def alter_postgresql_sequence( + project_id: str, instance_id: str, database_id: str +) -> None: + """Alters a PostgreSQL bit-reversed sequence SKIP RANGE and inserts rows. + + Args: + project_id: The Google Cloud project ID. + instance_id: The Spanner instance ID. + database_id: The PostgreSQL-dialect Spanner database ID with Seq. + """ + admin_client = spanner_admin_database_v1.DatabaseAdminClient() + database_path = admin_client.database_path(project_id, instance_id, database_id) + ddl_request = spanner_admin_database_v1.UpdateDatabaseDdlRequest( + database=database_path, + statements=["ALTER SEQUENCE Seq SKIP RANGE 1000 5000000"], + ) + client = spanner.Client(project=project_id) + database = client.instance(instance_id).database(database_id) + customer_ids: list[int] = [] + + def insert_customers(transaction: spanner_v1.transaction.Transaction) -> None: + nonlocal customer_ids + rows = list( + transaction.execute_sql( + "INSERT INTO Customers (CustomerName) VALUES " + "('Lea'), ('Cataline'), ('Smith') " + "RETURNING CustomerId" + ) + ) + customer_ids = [int(row[0]) for row in rows] + + try: + operation = admin_client.update_database_ddl(request=ddl_request) + print(f"Waiting for PostgreSQL sequence 'Seq' alteration on '{database_id}'...") + operation.result(timeout=300) + database.run_in_transaction(insert_customers) + 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 exceptions.GoogleAPICallError as err: + print( + f"error: failed to alter PostgreSQL sequence on database " + f"'{database_id}' in instance '{instance_id}': {err.message}", + file=sys.stderr, + ) + else: + print(f"Resource ID: {database_id}") + for cid in customer_ids: + print(f"Customer ID: {cid}") + print(f"Inserted Customers: {len(customer_ids)}") + + +# [END spanner_postgresql_alter_sequence] + + +if __name__ == "__main__": + import argparse + import os + + parser = argparse.ArgumentParser( + description="Alter a PostgreSQL bit-reversed sequence SKIP RANGE." + ) + 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_PG_DATABASE_ID", "example-db"), + help="Spanner database ID", + ) + args = parser.parse_args() + + alter_postgresql_sequence( + project_id=args.project_id, + instance_id=args.instance_id, + database_id=args.database_id, + ) diff --git a/spanner/postgresql/tests/postgresql_alter_sequence_test.py b/spanner/postgresql/tests/postgresql_alter_sequence_test.py new file mode 100644 index 0000000000..616e148a8b --- /dev/null +++ b/spanner/postgresql/tests/postgresql_alter_sequence_test.py @@ -0,0 +1,188 @@ +# 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 + +from google.api_core import exceptions +from google.cloud import spanner_admin_database_v1 +import pytest +from spanner_postgresql import postgresql_alter_sequence +from spanner_postgresql import postgresql_create_sequence +from spanner_postgresql import postgresql_drop_sequence + +from . import conftest + +PROJECT_ID = "example-project-id" +INSTANCE_ID = "example-instance" +DATABASE_ID = "example-pg-db" +ADMIN_CLIENT = "google.cloud.spanner_admin_database_v1.DatabaseAdminClient" +SPANNER_CLIENT = "google.cloud.spanner.Client" + + +def _setup_txn(mock_client_class: mock.MagicMock) -> mock.MagicMock: + database = ( + mock_client_class.return_value.instance.return_value.database.return_value + ) + txn = mock.MagicMock() + database.run_in_transaction.side_effect = lambda fn, *a, **kw: fn(txn) + return txn + + +@mock.patch(SPANNER_CLIENT) +@mock.patch(ADMIN_CLIENT) +def test_alter_postgresql_sequence_success( + mock_admin_class: mock.MagicMock, + mock_client_class: mock.MagicMock, + capsys: pytest.CaptureFixture[str], +) -> None: + mock_admin_class.return_value.instance_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}" + ) + mock_admin_class.return_value.database_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" + ) + txn = _setup_txn(mock_client_class) + txn.execute_sql.return_value = [(6000001,), (6000002,), (6000003,)] + + postgresql_alter_sequence.alter_postgresql_sequence( + PROJECT_ID, INSTANCE_ID, DATABASE_ID + ) + + req = mock_admin_class.return_value.update_database_ddl.call_args.kwargs["request"] + assert req.statements == ["ALTER SEQUENCE Seq SKIP RANGE 1000 5000000"] + out, err = capsys.readouterr() + assert f"Resource ID: {DATABASE_ID}" in out + assert "Inserted Customers: 3" in out + assert PROJECT_ID not in out + assert err == "" + + +@pytest.mark.parametrize( + "error, expected_prefix", + [ + (exceptions.NotFound("missing"), "error: database 'example-pg-db'"), + ( + exceptions.FailedPrecondition("missing seq"), + "error: failed to alter PostgreSQL sequence", + ), + ], +) +@mock.patch(SPANNER_CLIENT) +@mock.patch(ADMIN_CLIENT) +def test_alter_postgresql_sequence_errors( + mock_admin_class: mock.MagicMock, + mock_client_class: mock.MagicMock, + capsys: pytest.CaptureFixture[str], + error: Exception, + expected_prefix: str, +) -> None: + mock_admin_class.return_value.instance_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}" + ) + mock_admin_class.return_value.database_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" + ) + mock_admin_class.return_value.update_database_ddl.side_effect = error + + postgresql_alter_sequence.alter_postgresql_sequence( + PROJECT_ID, INSTANCE_ID, DATABASE_ID + ) + + _out, err = capsys.readouterr() + assert err.startswith(expected_prefix) + assert PROJECT_ID not in err + + +@mock.patch(SPANNER_CLIENT) +@mock.patch(ADMIN_CLIENT) +def test_alter_postgresql_sequence_cli_entrypoint( + mock_admin_class: mock.MagicMock, + mock_client_class: mock.MagicMock, + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + mock_admin_class.return_value.instance_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}" + ) + mock_admin_class.return_value.database_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" + ) + txn = _setup_txn(mock_client_class) + txn.execute_sql.return_value = [(6000001,), (6000002,), (6000003,)] + monkeypatch.setattr( + "sys.argv", + [ + "postgresql_alter_sequence.py", + "--project-id", + PROJECT_ID, + "--instance-id", + INSTANCE_ID, + "--database-id", + DATABASE_ID, + ], + ) + + runpy.run_module( + "spanner_postgresql.postgresql_alter_sequence", run_name="__main__" + ) + + assert "Inserted Customers: 3" in capsys.readouterr().out + + +@conftest.live_only +def test_alter_postgresql_sequence_live(capsys: pytest.CaptureFixture[str]) -> None: + admin = spanner_admin_database_v1.DatabaseAdminClient() + db_path = admin.database_path( + conftest.LIVE_PROJECT_ID, + conftest.LIVE_INSTANCE_ID, + conftest.LIVE_DATABASE_ID, + ) + admin.update_database_ddl( + request={ + "database": db_path, + "statements": [ + "DROP TABLE IF EXISTS Customers", + "DROP SEQUENCE IF EXISTS Seq", + ], + } + ).result(timeout=240) + try: + postgresql_create_sequence.create_postgresql_sequence( + conftest.LIVE_PROJECT_ID, + conftest.LIVE_INSTANCE_ID, + conftest.LIVE_DATABASE_ID, + ) + capsys.readouterr() + postgresql_alter_sequence.alter_postgresql_sequence( + conftest.LIVE_PROJECT_ID, + conftest.LIVE_INSTANCE_ID, + conftest.LIVE_DATABASE_ID, + ) + out, err = capsys.readouterr() + assert err == "" + assert conftest.LIVE_PROJECT_ID not in out + assert "Inserted Customers: 3" in out + finally: + postgresql_drop_sequence.drop_postgresql_sequence( + conftest.LIVE_PROJECT_ID, + conftest.LIVE_INSTANCE_ID, + conftest.LIVE_DATABASE_ID, + ) + admin.update_database_ddl( + request={ + "database": db_path, + "statements": ["DROP TABLE IF EXISTS Customers"], + } + ).result(timeout=240) From b8b9408d3977f0c1141ab496ad9ca8a1c035ad3b Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Wed, 18 Nov 2026 21:42:53 +0000 Subject: [PATCH 2/3] fix(spanner): report operation wait timeouts in postgresql_alter_sequence Problem: the sample waits on a long-running operation with a client-side timeout. When that wait expires the client raises TimeoutError, which is not an API call error, so the sample ended with an unhandled traceback. Solution: catch TimeoutError and print a clear message to stderr noting that only the wait timed out and the operation may still be running (the timeout does not cancel it). Add a unit test covering the new handler. --- .../src/spanner_postgresql/postgresql_alter_sequence.py | 6 ++++++ spanner/postgresql/tests/postgresql_alter_sequence_test.py | 1 + 2 files changed, 7 insertions(+) diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py b/spanner/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py index ee56aa5b9f..e51fe8ea8d 100644 --- a/spanner/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py @@ -63,6 +63,12 @@ def insert_customers(transaction: spanner_v1.transaction.Transaction) -> None: 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 alter PostgreSQL sequence on database " diff --git a/spanner/postgresql/tests/postgresql_alter_sequence_test.py b/spanner/postgresql/tests/postgresql_alter_sequence_test.py index 616e148a8b..9e76cf504b 100644 --- a/spanner/postgresql/tests/postgresql_alter_sequence_test.py +++ b/spanner/postgresql/tests/postgresql_alter_sequence_test.py @@ -72,6 +72,7 @@ def test_alter_postgresql_sequence_success( @pytest.mark.parametrize( "error, expected_prefix", [ + (TimeoutError("deadline"), "error: timed out waiting for the operation"), (exceptions.NotFound("missing"), "error: database 'example-pg-db'"), ( exceptions.FailedPrecondition("missing seq"), From 445d48dc8dfc11294a5d27f9d1566f2c2a119b4a Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Thu, 19 Nov 2026 04:44:07 +0000 Subject: [PATCH 3/3] style(spanner): use triple-quoted SQL strings in postgresql_alter_sequence 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/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py --- .../spanner_postgresql/postgresql_alter_sequence.py | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py b/spanner/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py index e51fe8ea8d..fce0b51aad 100644 --- a/spanner/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_alter_sequence.py @@ -43,13 +43,11 @@ def alter_postgresql_sequence( def insert_customers(transaction: spanner_v1.transaction.Transaction) -> None: nonlocal customer_ids - rows = list( - transaction.execute_sql( - "INSERT INTO Customers (CustomerName) VALUES " - "('Lea'), ('Cataline'), ('Smith') " - "RETURNING CustomerId" - ) - ) + rows = list(transaction.execute_sql(""" + INSERT INTO Customers (CustomerName) VALUES + ('Lea'), ('Cataline'), ('Smith') + RETURNING CustomerId + """)) customer_ids = [int(row[0]) for row in rows] try: