feat: parse query parameters in PostgreSQL query #1732
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PostgreSQL supports newline characters in string literals and quoted identifiers. Trying to execute a statement with a string literal or quoted identifier that contained a newline character would cause an 'Unclosed string literal' error. Fixes #1730
Adds a helper method to get the parameters from a PostgreSQL query. This is needed for DESCRIBE statement messages in PGAdapter, as it must return the data types of all query parameters in a query string. Even though this parser is not able to determine the parameter types, it is able to determine the number of parameters. This again makes it possible to PGAdapter to return Oid.UNSPECIFIED for each parameter in the query string, which is enough for most clients.
product-auto-label
bot
added
the
api: spanner
thiagotnunes
approved these changes
Mar 8, 2022
| * @return A set containing all the parameters in the SQL-string. | ||
| */ | ||
| @InternalApi | ||
| public Set<String> getQueryParameters(String sql) { |
There was a problem hiding this comment.
I imagine we don't need to consider malformed queries here (select col$4" from some_table ...)
There was a problem hiding this comment.
Correct. That is caught by the preceding step (removeCommentsAndTrim) that should be taken by any well-informed users of the API.
| char currentChar = sql.charAt(currentIndex); | ||
| if (currentChar == SINGLE_QUOTE || currentChar == DOUBLE_QUOTE) { | ||
| result.append(currentChar); | ||
| appendIfNotNull(result, currentChar); |
There was a problem hiding this comment.
nit: will it ever be null?
There was a problem hiding this comment.
Yes, result will be null if the caller does not need the result. That's a (minor) performance optimization not to build a resulting query string when the call just wants to scan through the SQL string to extract specific information. So in this specific case we skip building a result string as we are only interested in extracting the query parameters, and not building a new SQL string with for example a different style query parameters (e.g. when converting JDBC style ? parameters to PostgreSQL style parameters $1).
olavloite
added
the
automerge
gcf-merge-on-green
bot
removed
the
automerge
gcf-owl-bot bot
added a commit
that referenced
this pull request
Dec 12, 2022
…cp/templates/java_library/.kokoro (#1732) build(deps): bump certifi Bumps [certifi](https://github.com/certifi/python-certifi) from 2022.9.24 to 2022.12.7. - [Release notes](https://github.com/certifi/python-certifi/releases) - [Commits](certifi/python-certifi@2022.09.24...2022.12.07) --- updated-dependencies: - dependency-name: certifi dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jeff Ching <[email protected]> Source-Link: googleapis/synthtool@ae0d43e Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-java:latest@sha256:9de537d592b60e5eac73b374a28263969bae91ecdb29b445e894576fbf54851c
gcf-merge-on-green bot
pushed a commit
that referenced
this pull request
Dec 22, 2022
…cp/templates/java_library/.kokoro (#1732) (#2194) build(deps): bump certifi Bumps [certifi](https://togithub.com/certifi/python-certifi) from 2022.9.24 to 2022.12.7. - [Release notes](https://togithub.com/certifi/python-certifi/releases) - [Commits](https://togithub.com/certifi/python-certifi/compare/2022.09.24...2022.12.07) --- updated-dependencies: - dependency-name: certifi dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jeff Ching <[email protected]> Source-Link: https://togithub.com/googleapis/synthtool/commit/ae0d43e5f17972981fe501ecf5a5d20055128bea Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-java:latest@sha256:9de537d592b60e5eac73b374a28263969bae91ecdb29b445e894576fbf54851c
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a helper method to get the parameters from a PostgreSQL query. This
is needed for DESCRIBE statement messages in PGAdapter, as it must
return the data types of all query parameters in a query string. Even
though this parser is not able to determine the parameter types, it is
able to determine the number of parameters. This again makes it possible
to PGAdapter to return Oid.UNSPECIFIED for each parameter in the query
string, which is enough for most clients.
cc @pratickchokhani