From a4ecd82af0e7409f951ed2395dbf3b3e662da711 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Tue, 17 Nov 2026 23:45:57 +0000 Subject: [PATCH 1/3] feat(spanner): Add PostgreSQL DELETE DML RETURNING sample PostgreSQL-dialect Spanner uses DELETE ... RETURNING to capture deleted row identifiers and generated columns. --- .../postgresql_delete_dml_returning.py | 104 ++++++++++++ .../postgresql_delete_dml_returning_test.py | 157 ++++++++++++++++++ 2 files changed, 261 insertions(+) create mode 100644 spanner/postgresql/src/spanner_postgresql/postgresql_delete_dml_returning.py create mode 100644 spanner/postgresql/tests/postgresql_delete_dml_returning_test.py diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_delete_dml_returning.py b/spanner/postgresql/src/spanner_postgresql/postgresql_delete_dml_returning.py new file mode 100644 index 0000000000..c1bcb59d84 --- /dev/null +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_delete_dml_returning.py @@ -0,0 +1,104 @@ +# 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_delete_dml_returning] +import sys + +from google.api_core import exceptions +from google.cloud import spanner +from google.cloud import spanner_v1 + + +def postgresql_delete_dml_returning( + project_id: str, instance_id: str, database_id: str +) -> None: + """Deletes matching Singers rows in PostgreSQL Spanner with RETURNING. + + Args: + project_id: The Google Cloud project ID. + instance_id: The Spanner instance ID. + database_id: The PostgreSQL-dialect Spanner database ID. + """ + client = spanner.Client(project=project_id) + database = client.instance(instance_id).database(database_id) + deleted_singers: list[tuple[int, str]] = [] + row_counts: list[int] = [] + + def delete_singers(transaction: spanner_v1.Transaction) -> None: + deleted_singers.clear() + row_counts.clear() + results = transaction.execute_sql( + "DELETE FROM Singers WHERE FirstName = 'David' " + "RETURNING SingerId, FullName" + ) + for singer_id, full_name in results: + deleted_singers.append((int(singer_id), str(full_name))) + row_counts.append(int(results.stats.row_count_exact)) + + try: + database.run_in_transaction(delete_singers) + except exceptions.NotFound as err: + print( + f"error: PostgreSQL database '{database_id}' on instance " + f"'{instance_id}' in project '{project_id}' was not found: " + f"{err.message}", + file=sys.stderr, + ) + except exceptions.GoogleAPICallError as err: + print( + f"error: PostgreSQL DELETE RETURNING failed on database " + f"'{database_id}' in instance '{instance_id}' for project " + f"'{project_id}': {err.message}", + file=sys.stderr, + ) + else: + print(f"Resource ID: {database.name}") + print(f"Deleted Rows: {row_counts[-1]}") + for singer_id, full_name in deleted_singers: + print(f"Full Name: {full_name}") + print(f"Singer ID: {singer_id}") + + +# [END spanner_postgresql_delete_dml_returning] + + +if __name__ == "__main__": + import argparse + import os + + parser = argparse.ArgumentParser( + description="Delete Singers rows using PostgreSQL-dialect DML RETURNING." + ) + 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-pg-db"), + help="PostgreSQL-dialect Spanner database ID (default: $SPANNER_DATABASE_ID)", + ) + args = parser.parse_args() + + postgresql_delete_dml_returning( + project_id=args.project_id, + instance_id=args.instance_id, + database_id=args.database_id, + ) diff --git a/spanner/postgresql/tests/postgresql_delete_dml_returning_test.py b/spanner/postgresql/tests/postgresql_delete_dml_returning_test.py new file mode 100644 index 0000000000..e174885dab --- /dev/null +++ b/spanner/postgresql/tests/postgresql_delete_dml_returning_test.py @@ -0,0 +1,157 @@ +# 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 +import pytest +from spanner_postgresql import postgresql_delete_dml_returning + +from . import conftest + +PROJECT_ID = "example-project-id" +INSTANCE_ID = "example-instance" +DATABASE_ID = "example-pg-db" +DATABASE_NAME = f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" +SPANNER_CLIENT = "google.cloud.spanner.Client" + + +def _mock_result_set(rows: list[tuple[object, ...]], count: int) -> mock.MagicMock: + rs = mock.MagicMock() + rs.__iter__.return_value = iter(rows) + rs.stats.row_count_exact = count + return rs + + +@mock.patch(SPANNER_CLIENT) +def test_postgresql_delete_dml_returning_success( + mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str] +) -> None: + database = ( + mock_client_class.return_value.instance.return_value.database.return_value + ) + database.name = DATABASE_NAME + transaction = mock.MagicMock() + transaction.execute_sql.return_value = _mock_result_set([(25, "David Lee")], 1) + database.run_in_transaction.side_effect = lambda fn: fn(transaction) + + postgresql_delete_dml_returning.postgresql_delete_dml_returning( + PROJECT_ID, INSTANCE_ID, DATABASE_ID + ) + + sql = transaction.execute_sql.call_args.args[0] + assert "RETURNING SingerId, FullName" in sql + out, err = capsys.readouterr() + assert f"Resource ID: {DATABASE_NAME}" in out + assert "Deleted Rows: 1" in out + assert "Full Name: David Lee" in out + assert "Singer ID: 25" in out + assert err == "" + + +@pytest.mark.parametrize( + "error, expected_prefix", + [ + ( + exceptions.NotFound("db missing"), + "error: PostgreSQL database 'example-pg-db' on instance", + ), + ( + exceptions.Aborted("aborted"), + "error: PostgreSQL DELETE RETURNING failed", + ), + ], +) +@mock.patch(SPANNER_CLIENT) +def test_postgresql_delete_dml_returning_errors( + mock_client_class: mock.MagicMock, + capsys: pytest.CaptureFixture[str], + error: Exception, + expected_prefix: str, +) -> None: + database = ( + mock_client_class.return_value.instance.return_value.database.return_value + ) + database.run_in_transaction.side_effect = error + + postgresql_delete_dml_returning.postgresql_delete_dml_returning( + PROJECT_ID, INSTANCE_ID, DATABASE_ID + ) + + out, err = capsys.readouterr() + assert out == "" + assert err.startswith(expected_prefix) + + +@mock.patch(SPANNER_CLIENT) +def test_postgresql_delete_dml_returning_cli_entrypoint( + mock_client_class: mock.MagicMock, + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + database = ( + mock_client_class.return_value.instance.return_value.database.return_value + ) + database.name = DATABASE_NAME + transaction = mock.MagicMock() + transaction.execute_sql.return_value = _mock_result_set([(25, "David Lee")], 1) + database.run_in_transaction.side_effect = lambda fn: fn(transaction) + monkeypatch.setattr( + "sys.argv", + [ + "postgresql_delete_dml_returning.py", + "--project-id", + PROJECT_ID, + "--instance-id", + INSTANCE_ID, + "--database-id", + DATABASE_ID, + ], + ) + + runpy.run_module( + "spanner_postgresql.postgresql_delete_dml_returning", run_name="__main__" + ) + + assert "Deleted Rows: 1" in capsys.readouterr().out + + +@conftest.live_only +def test_postgresql_delete_dml_returning_live( + capsys: pytest.CaptureFixture[str], +) -> None: + client = spanner.Client(project=conftest.LIVE_PROJECT_ID) + database = client.instance(conftest.LIVE_INSTANCE_ID).database( + conftest.LIVE_DATABASE_ID + ) + with database.batch() as batch: + batch.insert_or_update( + table="singers", + columns=("singerid", "firstname", "lastname"), + values=[(25, "David", "Lee")], + ) + + postgresql_delete_dml_returning.postgresql_delete_dml_returning( + conftest.LIVE_PROJECT_ID, + conftest.LIVE_INSTANCE_ID, + conftest.LIVE_DATABASE_ID, + ) + + out, err = capsys.readouterr() + assert err == "" + assert "Deleted Rows: 1" in out + assert "Full Name: David Lee" in out + assert "Singer ID: 25" in out From d364146b06ef234d86eba5473b32a82118d5aa34 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Wed, 18 Nov 2026 00:38:18 +0000 Subject: [PATCH 2/3] fix(spanner): Guard query stats, use nonlocal, and omit project_id Uses a nonlocal row counter with a defensive results.stats check and omits project identifiers from stdout and stderr. --- .../postgresql_delete_dml_returning.py | 16 +++++++--------- .../postgresql_delete_dml_returning_test.py | 5 ++++- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_delete_dml_returning.py b/spanner/postgresql/src/spanner_postgresql/postgresql_delete_dml_returning.py index c1bcb59d84..392ecce373 100644 --- a/spanner/postgresql/src/spanner_postgresql/postgresql_delete_dml_returning.py +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_delete_dml_returning.py @@ -33,38 +33,36 @@ def postgresql_delete_dml_returning( client = spanner.Client(project=project_id) database = client.instance(instance_id).database(database_id) deleted_singers: list[tuple[int, str]] = [] - row_counts: list[int] = [] + row_count = 0 def delete_singers(transaction: spanner_v1.Transaction) -> None: + nonlocal row_count deleted_singers.clear() - row_counts.clear() results = transaction.execute_sql( "DELETE FROM Singers WHERE FirstName = 'David' " "RETURNING SingerId, FullName" ) for singer_id, full_name in results: deleted_singers.append((int(singer_id), str(full_name))) - row_counts.append(int(results.stats.row_count_exact)) + row_count = int(results.stats.row_count_exact) if results.stats else 0 try: database.run_in_transaction(delete_singers) except exceptions.NotFound as err: print( f"error: PostgreSQL database '{database_id}' on instance " - f"'{instance_id}' in project '{project_id}' was not found: " - f"{err.message}", + f"'{instance_id}' was not found: {err.message}", file=sys.stderr, ) except exceptions.GoogleAPICallError as err: print( f"error: PostgreSQL DELETE RETURNING failed on database " - f"'{database_id}' in instance '{instance_id}' for project " - f"'{project_id}': {err.message}", + f"'{database_id}' in instance '{instance_id}': {err.message}", file=sys.stderr, ) else: - print(f"Resource ID: {database.name}") - print(f"Deleted Rows: {row_counts[-1]}") + print(f"Resource ID: {database_id}") + print(f"Deleted Rows: {row_count}") for singer_id, full_name in deleted_singers: print(f"Full Name: {full_name}") print(f"Singer ID: {singer_id}") diff --git a/spanner/postgresql/tests/postgresql_delete_dml_returning_test.py b/spanner/postgresql/tests/postgresql_delete_dml_returning_test.py index e174885dab..a291565edb 100644 --- a/spanner/postgresql/tests/postgresql_delete_dml_returning_test.py +++ b/spanner/postgresql/tests/postgresql_delete_dml_returning_test.py @@ -55,7 +55,8 @@ def test_postgresql_delete_dml_returning_success( sql = transaction.execute_sql.call_args.args[0] assert "RETURNING SingerId, FullName" in sql out, err = capsys.readouterr() - assert f"Resource ID: {DATABASE_NAME}" in out + assert f"Resource ID: {DATABASE_ID}" in out + assert PROJECT_ID not in out assert "Deleted Rows: 1" in out assert "Full Name: David Lee" in out assert "Singer ID: 25" in out @@ -94,6 +95,8 @@ def test_postgresql_delete_dml_returning_errors( out, err = capsys.readouterr() assert out == "" assert err.startswith(expected_prefix) + assert PROJECT_ID not in err + assert PROJECT_ID not in err @mock.patch(SPANNER_CLIENT) From 2202e528309f93aca427627b3d665386531a28cf Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Thu, 19 Nov 2026 04:42:06 +0000 Subject: [PATCH 3/3] style(spanner): use triple-quoted SQL strings in postgresql_delete_dml_returning 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_delete_dml_returning.py --- .../spanner_postgresql/postgresql_delete_dml_returning.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_delete_dml_returning.py b/spanner/postgresql/src/spanner_postgresql/postgresql_delete_dml_returning.py index 392ecce373..f5b3f94f6a 100644 --- a/spanner/postgresql/src/spanner_postgresql/postgresql_delete_dml_returning.py +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_delete_dml_returning.py @@ -38,10 +38,10 @@ def postgresql_delete_dml_returning( def delete_singers(transaction: spanner_v1.Transaction) -> None: nonlocal row_count deleted_singers.clear() - results = transaction.execute_sql( - "DELETE FROM Singers WHERE FirstName = 'David' " - "RETURNING SingerId, FullName" - ) + results = transaction.execute_sql(""" + DELETE FROM Singers WHERE FirstName = 'David' + RETURNING SingerId, FullName + """) for singer_id, full_name in results: deleted_singers.append((int(singer_id), str(full_name))) row_count = int(results.stats.row_count_exact) if results.stats else 0