Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release-22.1: sql: hide number of placeholder #88364

Merged
merged 1 commit into from
Sep 21, 2022

Conversation

blathers-crl[bot]
Copy link

@blathers-crl blathers-crl bot commented Sep 21, 2022

Backport 1/1 commits from #88215 on behalf of @maryliag.

/cc @cockroachdb/release


Previously, placeholder values were kept as is
for fingerprint creation, meaning IN ($1, $2)
would be a different fingerprint than IN ($2, $1) even though they should be the same.
This commit replace all placeholder values with $1, so we
can still know it was a placeholder, but we don't care about the
number of the placeholder itself.
This is the simplest solution to solve this problem. Other
options (e.g. replace with $_ or p_) were considered but
ultimately they would require other modification on the parser code
to accept these values.

Previously:
SELECT * FROM t WHERE v IN ($1, $2) -> SELECT * FROM t WHERE v IN ($1, $2)
SELECT * FROM t WHERE v IN ($2, $1) -> SELECT * FROM t WHERE v IN ($2, $1)

Now:
SELECT * FROM t WHERE v IN ($1, $2) -> SELECT * FROM t WHERE v IN ($1, $1)
SELECT * FROM t WHERE v IN ($2, $1) -> SELECT * FROM t WHERE v IN ($1, $1)

Fixes #88074

Release note (sql change): The index of a placeholder
is now replaced to always be $1 to limit fingerprint creations.


Release justification: low risk, high benefit change

Previously, placeholder values were kept as is
for fingerprint creation, meaning `IN ($1, $2)`
would be a different fingerprint than `IN ($2, $1)`
even though they should be the same.
This commit replace all placeholder values with `$1`, so we
can still know it was a placeholder, but we don't care about the
number of the placeholder itself.
This is the simplest solution to solve this problem. Other
options (e.g. replace with `$_` or `p_`) were considered but
ultimately they would require other modification on the parser code
to accept these values.

Previously:
`SELECT * FROM t WHERE v IN ($1, $2)` -> `SELECT * FROM t WHERE v IN ($1, $2)`
`SELECT * FROM t WHERE v IN ($2, $1)` -> `SELECT * FROM t WHERE v IN ($2, $1)`

Now:
`SELECT * FROM t WHERE v IN ($1, $2)` -> `SELECT * FROM t WHERE v IN ($1, $1)`
`SELECT * FROM t WHERE v IN ($2, $1)` -> `SELECT * FROM t WHERE v IN ($1, $1)`

Fixes #88074

Release note (sql change): The index of a placeholder
is now replaced to always be `$1` to limit fingerprint creations.
@blathers-crl blathers-crl bot requested a review from a team as a code owner September 21, 2022 16:39
@blathers-crl blathers-crl bot force-pushed the blathers/backport-release-22.1-88215 branch from 00a848f to 6fa8bb4 Compare September 21, 2022 16:39
@blathers-crl blathers-crl bot added blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot. labels Sep 21, 2022
@blathers-crl
Copy link
Author

blathers-crl bot commented Sep 21, 2022

Thanks for opening a backport.

Please check the backport criteria before merging:

  • Patches should only be created for serious issues or test-only changes.
  • Patches should not break backwards-compatibility.
  • Patches should change as little code as possible.
  • Patches should not change on-disk formats or node communication protocols.
  • Patches should not add new functionality.
  • Patches must not add, edit, or otherwise modify cluster versions; or add version gates.
If some of the basic criteria cannot be satisfied, ensure that the exceptional criteria are satisfied within.
  • There is a high priority need for the functionality that cannot wait until the next release and is difficult to address in another way.
  • The new functionality is additive-only and only runs for clusters which have specifically “opted in” to it (e.g. by a cluster setting).
  • New code is protected by a conditional check that is trivial to verify and ensures that it only runs for opt-in clusters.
  • The PM and TL on the team that owns the changed code have signed off that the change obeys the above rules.

Add a brief release justification to the body of your PR to justify this backport.

Some other things to consider:

  • What did we do to ensure that a user that doesn’t know & care about this backport, has no idea that it happened?
  • Will this work in a cluster of mixed patch versions? Did we test that?
  • If a user upgrades a patch version, uses this feature, and then downgrades, what happens?

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@maryliag maryliag requested a review from a team September 21, 2022 17:15
Copy link
Member

@xinhaoz xinhaoz left a comment

Choose a reason for hiding this comment

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

Reviewed all commit messages.
Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained (waiting on @maryliag and @matthewtodd)

@maryliag maryliag merged commit 5e13acb into release-22.1 Sep 21, 2022
@maryliag maryliag deleted the blathers/backport-release-22.1-88215 branch September 21, 2022 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blathers-backport This is a backport that Blathers created automatically. O-robot Originated from a bot.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants