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

Parse enum/set values with sqlparser #17133

Merged

Conversation

shlomi-noach
Copy link
Contributor

Description

This is a minor refactor/cleanup PR, followup to #15493.

https://github.com/vitessio/vitess/pull/15493/files#diff-e6d36f19ff8893ef05db3d0b9297a87ed3a0ecb6cdf7486c93718344b2ac25f9 introduced a CSV-style parsing to the enum set (e.g. 'x-small','small','medium','large','x-large'). In this PR we use sqlparser to parse these values. sqlparser cannot directly parse this, so we wrap around with a dummy query:

alter table t add column e enum('x-small','small','medium','large','x-large')

We then parse the complete query. This is more wasteful, of course, as we need to parse a statement, cast to AlterTable, extract AddColumns, and finally read EnumValues. Nonetheless, this utilizes our de-facto parser and I think it's worth the overhead for the little use case this gets.

Related Issue(s)

#15492

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

Copy link
Contributor

vitess-bot bot commented Nov 4, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Nov 4, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Nov 4, 2024
@shlomi-noach shlomi-noach removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Nov 4, 2024
Signed-off-by: Shlomi Noach <[email protected]>
@shlomi-noach
Copy link
Contributor Author

shlomi-noach commented Nov 4, 2024

EDIT: this comment became irrelevant thanks to 02b6c9b


It is worth pointing out that escaped values are outputted differently:

input := `'with '' quote','and \n newline'`

Previously:

expect := []string{"with ' quote", "and \n newline"}

In this PR:

expect := []string{"with \\' quote", "and \\n newline"}

Copy link
Contributor

@dbussink dbussink left a comment

Choose a reason for hiding this comment

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

Like that this uses the proper parser now.

Copy link

codecov bot commented Nov 4, 2024

Codecov Report

Attention: Patch coverage is 70.00000% with 15 lines in your changes missing coverage. Please review.

Project coverage is 67.44%. Comparing base (fdf529e) to head (270c0d5).
Report is 8 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/schema/parser.go 70.27% 11 Missing ⚠️
go/vt/vttablet/tabletserver/vstreamer/vstreamer.go 69.23% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17133      +/-   ##
==========================================
+ Coverage   67.42%   67.44%   +0.01%     
==========================================
  Files        1571     1569       -2     
  Lines      252184   252109      -75     
==========================================
- Hits       170043   170032      -11     
+ Misses      82141    82077      -64     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Shlomi Noach <[email protected]>
@shlomi-noach
Copy link
Contributor Author

I pushed a small change that uses sqltypes.DecodeStringSQL to decode the enum values strings, which is even more formal now, and also happens to agree with the tests from before this PR, so that #17133 (comment) becomes irrelevant.

@shlomi-noach shlomi-noach merged commit 5b699d8 into vitessio:main Nov 6, 2024
98 checks passed
@shlomi-noach shlomi-noach deleted the enum-values-parsing-sqlparser branch November 6, 2024 06:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants