Skip to content

feat(spanner): Add PostgreSQL DELETE DML RETURNING sample - #14865

Open
iennae wants to merge 3 commits into
feat/spanner-postgresql-dml-last-statementfrom
feat/spanner-postgresql-delete-dml-returning
Open

iennae wants to merge 3 commits into
feat/spanner-postgresql-dml-last-statementfrom
feat/spanner-postgresql-delete-dml-returning

Conversation

@iennae

@iennae iennae commented Nov 17, 2026

Copy link
Copy Markdown
Contributor

Description

PostgreSQL-dialect Spanner databases use DELETE ... RETURNING to return deleted row values atomically inside a transaction.

Adds spanner_postgresql_delete_dml_returning using the canonical cross-language region tag.

Note: Stacked on #14851 (feat/spanner-postgresql-dml-last-statement) so this PR shows only this sample's diff. It will merge into main after #14851.

Checklist

Testing

  • I have tested this change on a live environment and verified it works as intended. Unit and live integration tests pass on Python 3.13.

Compliance & Style


Post-Approval Actions

  • Please merge this PR for me once it is approved

PostgreSQL-dialect Spanner uses DELETE ... RETURNING to capture deleted row identifiers and generated columns.
@iennae
iennae requested review from a team as code owners November 17, 2026 23:48
@product-auto-label product-auto-label Bot added api: spanner Issues related to the Spanner API. samples Issues that are directly related to samples. labels Nov 17, 2026
@snippet-bot

snippet-bot Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Here is the summary of changes.

You are about to add 1 region tag.

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • Refresh this comment

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new Python sample and corresponding tests demonstrating how to perform a PostgreSQL-dialect Spanner DELETE DML operation with a RETURNING clause. The feedback suggests a cleaner, more idiomatic Python 3 refactoring: replacing the legacy Python 2 pattern of using a list (row_counts) to emulate a mutable cell with the nonlocal keyword to rebind variables in the outer scope.

Comment on lines +35 to +47
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))

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using a list (row_counts) to emulate a mutable cell is a legacy Python 2 pattern. In Python 3, you can use the nonlocal keyword to rebind variables in the outer scope from within a nested function. This is cleaner and more idiomatic.

Suggested change
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))
deleted_singers: list[tuple[int, str]] = []
row_count = 0
def delete_singers(transaction: spanner_v1.Transaction) -> None:
nonlocal deleted_singers, row_count
deleted_singers = []
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)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This comment refers to an earlier revision of this file; the code here has since been reworked in later commits, so this thread no longer applies to the current diff.

)
else:
print(f"Resource ID: {database.name}")
print(f"Deleted Rows: {row_counts[-1]}")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Update this line to use the row_count variable instead of the row_counts list, matching the nonlocal refactoring.

Suggested change
print(f"Deleted Rows: {row_counts[-1]}")
print(f"Deleted Rows: {row_count}")

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This comment refers to an earlier revision of this file; the code here has since been reworked in later commits, so this thread no longer applies to the current diff.

Uses a nonlocal row counter with a defensive results.stats check and omits project identifiers from stdout and stderr.
…l_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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: spanner Issues related to the Spanner API. samples Issues that are directly related to samples.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants