From e2a5f097203b9582ff265085be6493f32f636d43 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 UPDATE DML RETURNING sample PostgreSQL-dialect Spanner uses UPDATE ... RETURNING to inspect modified columns without issuing a separate SELECT. --- .../postgresql_update_dml_returning.py | 105 ++++++++++++ .../postgresql_update_dml_returning_test.py | 155 ++++++++++++++++++ 2 files changed, 260 insertions(+) create mode 100644 spanner/postgresql/src/spanner_postgresql/postgresql_update_dml_returning.py create mode 100644 spanner/postgresql/tests/postgresql_update_dml_returning_test.py diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_update_dml_returning.py b/spanner/postgresql/src/spanner_postgresql/postgresql_update_dml_returning.py new file mode 100644 index 0000000000..60d0c2fa02 --- /dev/null +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_update_dml_returning.py @@ -0,0 +1,105 @@ +# 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_update_dml_returning] +import sys + +from google.api_core import exceptions +from google.cloud import spanner +from google.cloud import spanner_v1 + + +def postgresql_update_dml_returning( + project_id: str, instance_id: str, database_id: str +) -> None: + """Updates Albums MarketingBudget 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) + budgets: list[int] = [] + row_counts: list[int] = [] + + def update_albums(transaction: spanner_v1.Transaction) -> None: + budgets.clear() + row_counts.clear() + results = transaction.execute_sql( + "UPDATE Albums " + "SET MarketingBudget = MarketingBudget * 2 " + "WHERE SingerId = 1 AND AlbumId = 1 " + "RETURNING MarketingBudget" + ) + for row in results: + budgets.append(int(row[0] or 0)) + row_counts.append(int(results.stats.row_count_exact)) + + try: + database.run_in_transaction(update_albums) + 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 UPDATE 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}") + for budget in budgets: + print(f"Marketing Budget: {budget}") + print(f"Updated Rows: {row_counts[-1]}") + + +# [END spanner_postgresql_update_dml_returning] + + +if __name__ == "__main__": + import argparse + import os + + parser = argparse.ArgumentParser( + description="Update Albums 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_update_dml_returning( + project_id=args.project_id, + instance_id=args.instance_id, + database_id=args.database_id, + ) diff --git a/spanner/postgresql/tests/postgresql_update_dml_returning_test.py b/spanner/postgresql/tests/postgresql_update_dml_returning_test.py new file mode 100644 index 0000000000..d608dbc678 --- /dev/null +++ b/spanner/postgresql/tests/postgresql_update_dml_returning_test.py @@ -0,0 +1,155 @@ +# 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_update_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_update_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([(200000,)], 1) + database.run_in_transaction.side_effect = lambda fn: fn(transaction) + + postgresql_update_dml_returning.postgresql_update_dml_returning( + PROJECT_ID, INSTANCE_ID, DATABASE_ID + ) + + sql = transaction.execute_sql.call_args.args[0] + assert "RETURNING MarketingBudget" in sql + out, err = capsys.readouterr() + assert f"Resource ID: {DATABASE_NAME}" in out + assert "Marketing Budget: 200000" in out + assert "Updated Rows: 1" 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 UPDATE RETURNING failed", + ), + ], +) +@mock.patch(SPANNER_CLIENT) +def test_postgresql_update_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_update_dml_returning.postgresql_update_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_update_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([(200000,)], 1) + database.run_in_transaction.side_effect = lambda fn: fn(transaction) + monkeypatch.setattr( + "sys.argv", + [ + "postgresql_update_dml_returning.py", + "--project-id", + PROJECT_ID, + "--instance-id", + INSTANCE_ID, + "--database-id", + DATABASE_ID, + ], + ) + + runpy.run_module( + "spanner_postgresql.postgresql_update_dml_returning", run_name="__main__" + ) + + assert "Marketing Budget: 200000" in capsys.readouterr().out + + +@conftest.live_only +def test_postgresql_update_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.update( + table="albums", + columns=("singerid", "albumid", "marketingbudget"), + values=[(1, 1, 100000)], + ) + + postgresql_update_dml_returning.postgresql_update_dml_returning( + conftest.LIVE_PROJECT_ID, + conftest.LIVE_INSTANCE_ID, + conftest.LIVE_DATABASE_ID, + ) + + out, err = capsys.readouterr() + assert err == "" + assert "Marketing Budget: 200000" in out + assert "Updated Rows: 1" in out From a92d12bfc9f1e56e462095dd8ace3888dfe83205 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_update_dml_returning.py | 16 +++++++--------- .../postgresql_update_dml_returning_test.py | 5 ++++- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_update_dml_returning.py b/spanner/postgresql/src/spanner_postgresql/postgresql_update_dml_returning.py index 60d0c2fa02..70efe2a1ef 100644 --- a/spanner/postgresql/src/spanner_postgresql/postgresql_update_dml_returning.py +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_update_dml_returning.py @@ -33,11 +33,11 @@ def postgresql_update_dml_returning( client = spanner.Client(project=project_id) database = client.instance(instance_id).database(database_id) budgets: list[int] = [] - row_counts: list[int] = [] + row_count = 0 def update_albums(transaction: spanner_v1.Transaction) -> None: + nonlocal row_count budgets.clear() - row_counts.clear() results = transaction.execute_sql( "UPDATE Albums " "SET MarketingBudget = MarketingBudget * 2 " @@ -46,29 +46,27 @@ def update_albums(transaction: spanner_v1.Transaction) -> None: ) for row in results: budgets.append(int(row[0] or 0)) - 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(update_albums) 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 UPDATE 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"Resource ID: {database_id}") for budget in budgets: print(f"Marketing Budget: {budget}") - print(f"Updated Rows: {row_counts[-1]}") + print(f"Updated Rows: {row_count}") # [END spanner_postgresql_update_dml_returning] diff --git a/spanner/postgresql/tests/postgresql_update_dml_returning_test.py b/spanner/postgresql/tests/postgresql_update_dml_returning_test.py index d608dbc678..828a88d361 100644 --- a/spanner/postgresql/tests/postgresql_update_dml_returning_test.py +++ b/spanner/postgresql/tests/postgresql_update_dml_returning_test.py @@ -55,7 +55,8 @@ def test_postgresql_update_dml_returning_success( sql = transaction.execute_sql.call_args.args[0] assert "RETURNING MarketingBudget" 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 "Marketing Budget: 200000" in out assert "Updated Rows: 1" in out assert err == "" @@ -93,6 +94,8 @@ def test_postgresql_update_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 ab9b38938332c25ce3a85d88ddd66a2a335c351b Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Thu, 19 Nov 2026 04:42:02 +0000 Subject: [PATCH 3/3] style(spanner): use triple-quoted SQL strings in postgresql_update_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_update_dml_returning.py --- .../postgresql_update_dml_returning.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_update_dml_returning.py b/spanner/postgresql/src/spanner_postgresql/postgresql_update_dml_returning.py index 70efe2a1ef..256f7fc862 100644 --- a/spanner/postgresql/src/spanner_postgresql/postgresql_update_dml_returning.py +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_update_dml_returning.py @@ -38,12 +38,12 @@ def postgresql_update_dml_returning( def update_albums(transaction: spanner_v1.Transaction) -> None: nonlocal row_count budgets.clear() - results = transaction.execute_sql( - "UPDATE Albums " - "SET MarketingBudget = MarketingBudget * 2 " - "WHERE SingerId = 1 AND AlbumId = 1 " - "RETURNING MarketingBudget" - ) + results = transaction.execute_sql(""" + UPDATE Albums + SET MarketingBudget = MarketingBudget * 2 + WHERE SingerId = 1 AND AlbumId = 1 + RETURNING MarketingBudget + """) for row in results: budgets.append(int(row[0] or 0)) row_count = int(results.stats.row_count_exact) if results.stats else 0