Skip to content

fix(spanner): quote database names when creating databases - #19053

Open
olavloite wants to merge 1 commit into
mainfrom
spanner-quote-database-names
Open

olavloite wants to merge 1 commit into
mainfrom
spanner-quote-database-names

Conversation

@olavloite

Copy link
Copy Markdown
Contributor

Previously, the client only quoted database names in CREATE DATABASE statements if they contained a hyphen. If a database name matched a reserved SQL keyword (such as default or user), or was created without a hyphen under PostgreSQL dialect, the statement was sent without quotes, causing syntax errors from Cloud Spanner.

This change:

  • Unconditionally quotes database names in CREATE DATABASE statements using backticks for GoogleSQL and double quotes for PostgreSQL, aligning with the reference Java and Go clients.
  • Properly escapes quote and delimiter characters to prevent DDL injection breakouts.
  • Relies on Cloud Spanner server-side validation for invalid database identifiers rather than maintaining brittle client-side keyword lists.

Previously, the client only quoted database names in CREATE DATABASE statements if they contained a hyphen. If a database name matched a reserved SQL keyword (such as default or user), or was created without a hyphen under PostgreSQL dialect, the statement was sent without quotes, causing syntax errors from Cloud Spanner.

This change:
- Unconditionally quotes database names in CREATE DATABASE statements using backticks for GoogleSQL and double quotes for PostgreSQL, aligning with the reference Java and Go clients.
- Properly escapes quote and delimiter characters to prevent DDL injection breakouts.
- Relies on Cloud Spanner server-side validation for invalid database identifiers rather than maintaining brittle client-side keyword lists.
@olavloite
olavloite requested a review from a team as a code owner November 12, 2026 10:29

@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 updates the database creation logic in both the synchronous and asynchronous Spanner database clients to always quote and escape the database ID based on the database dialect (GoogleSQL or PostgreSQL). Previously, quoting was only applied if the database ID contained a hyphen. The changes ensure that special characters and reserved keywords are properly handled. Corresponding unit tests have been updated and expanded to cover various edge cases, including escaping delimiters and handling reserved keywords for both dialects. I have no further feedback to provide as there are no review comments.

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