Skip to content

fix(spanner): support parameters and preserve safety in partitioned DML - #19035

Open
olavloite wants to merge 1 commit into
mainfrom
spanner-preserve-params-in-pdml
Open

olavloite wants to merge 1 commit into
mainfrom
spanner-preserve-params-in-pdml

Conversation

@olavloite

Copy link
Copy Markdown
Contributor

Partitioned DML executed through the Cloud Spanner DB-API driver previously failed whenever query parameters were used. The driver passed raw positional placeholders and parameter lists directly to the database rather than converting them into the named parameters and data types expected by Cloud Spanner.

Additionally, statement parsing historically mutated SQL statements in place to automatically append a dummy "WHERE 1=1" clause to update and delete statements. Injecting this dummy clause into Partitioned DML is dangerous because Partitioned DML is non-atomic, irreversible, and cannot be rolled back. Bypassing Cloud Spanner's requirement for an explicit WHERE clause risks unintended full-table modifications.

This change addresses these issues by:

  • Properly translating and passing query parameters and their data types during Partitioned DML execution.
  • Making statement parsing pure and side-effect free so SQL statements are no longer mutated during classification.
  • Ensuring Partitioned DML statements never receive an automatic dummy WHERE clause, keeping Cloud Spanner's safety checks intact.
  • Guarding Partitioned DML mode so that statements executed inside an explicit transaction always run as atomic transactional DML.
  • Retaining automatic dummy WHERE clause injection exclusively for transactional and batch DML to preserve full backwards compatibility for existing applications.

@olavloite
olavloite requested a review from a team as a code owner November 10, 2026 12:23

@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 refactors the Spanner DB-API to prevent dummy WHERE clauses from being automatically added to partitioned DML statements. The logic for adding dummy WHERE clauses to UPDATE and DELETE statements is moved from the classification phase in parse_utils.py to specific cursor execution paths, and comprehensive tests are added to verify the new behavior. The review feedback suggests using the NamedTuple._replace() method in _ensure_where_clause to update the ParsedStatement and Statement objects more cleanly and safely.

Partitioned DML executed through the Cloud Spanner DB-API driver previously
failed whenever query parameters were used. The driver passed raw positional
placeholders and parameter lists directly to the database rather than converting
them into the named parameters and data types expected by Cloud Spanner.

Additionally, statement parsing historically mutated SQL statements in place
to automatically append a dummy "WHERE 1=1" clause to update and delete statements.
Injecting this dummy clause into Partitioned DML is dangerous because Partitioned
DML is non-atomic, irreversible, and cannot be rolled back. Bypassing Cloud
Spanner's requirement for an explicit WHERE clause risks unintended full-table
modifications.

This change addresses these issues by:
- Properly translating and passing query parameters and their data types
  during Partitioned DML execution.
- Making statement parsing pure and side-effect free so SQL statements are
  no longer mutated during classification.
- Ensuring Partitioned DML statements never receive an automatic dummy WHERE
  clause, keeping Cloud Spanner's safety checks intact.
- Guarding Partitioned DML mode so that statements executed inside an explicit
  transaction always run as atomic transactional DML.
- Retaining automatic dummy WHERE clause injection exclusively for transactional
  and batch DML to preserve full backwards compatibility for existing applications.
@olavloite
olavloite force-pushed the spanner-preserve-params-in-pdml branch from 47b8ba8 to 218d44b Compare November 10, 2026 12:39
@olavloite

Copy link
Copy Markdown
Contributor Author

/gemini review

@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 refactors how dummy WHERE clauses are added to unqualified UPDATE and DELETE statements in the Spanner DB API. Instead of automatically appending 'WHERE 1=1' during statement classification in parse_utils.py, the logic is moved to the cursor execution level via a new _ensure_where_clause helper. This ensures that partitioned DML statements do not receive a dummy WHERE clause, while transactional DML, batch DML, and executemany statements still do. Comprehensive unit and mock server tests have been added to verify these behaviors, including idempotency during transaction retries. I have no further feedback to provide.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant