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

fix: add missing MySQL 8.4 reserved keywords #17525

Closed

Conversation

L3o-pold
Copy link
Collaborator

@L3o-pold L3o-pold commented Jan 15, 2025

Description

MySQL 8.4 introduce new reserved keywords: https://dev.mysql.com/doc/mysqld-version-reference/en/keywords-8-4.html#keywords-new-in-8-4

Related Issue(s)

Fixes #17523

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 Jan 15, 2025

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 Jan 15, 2025
@github-actions github-actions bot added this to the v22.0.0 milestone Jan 15, 2025
@L3o-pold L3o-pold force-pushed the mysql-84-reserved-keywords branch from 83dcc4c to 3d3f413 Compare January 15, 2025 11:53
Copy link
Contributor

@GrahamCampbell GrahamCampbell left a comment

Choose a reason for hiding this comment

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

I think we maybe also want VECTOR as a keyword, from MySQL 9.0.

@GrahamCampbell
Copy link
Contributor

cc @dbussink r.e. the VECTOR keyword, as you authored #16464.

Copy link
Contributor

@GrahamCampbell GrahamCampbell left a comment

Choose a reason for hiding this comment

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

go/vt/sqlparser/keywords.go needs updating, and probably some other stuff

Copy link

codecov bot commented Jan 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.70%. Comparing base (a9d6969) to head (3d3f413).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17525      +/-   ##
==========================================
+ Coverage   67.69%   67.70%   +0.01%     
==========================================
  Files        1584     1584              
  Lines      254541   254509      -32     
==========================================
+ Hits       172315   172322       +7     
+ Misses      82226    82187      -39     

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

@L3o-pold
Copy link
Collaborator Author

I have no idea how sql.y is supposed to be edited to handle new reserved keywords.

@L3o-pold L3o-pold force-pushed the mysql-84-reserved-keywords branch from 32fabe4 to 0057167 Compare January 15, 2025 12:59
@L3o-pold L3o-pold force-pushed the mysql-84-reserved-keywords branch from 0057167 to 40b6a05 Compare January 15, 2025 13:17
@dbussink
Copy link
Contributor

cc @dbussink r.e. the VECTOR keyword, as you authored #16464.

Not really sure why this is relevant, as VECTOR is explicitly not a reserved keyword, so it wasn't added as such either.

@GrahamCampbell
Copy link
Contributor

It's not reserved, but it is a keyword, and it is missing from the generated test file.

@dbussink
Copy link
Contributor

@L3o-pold So one main thing. We should not add the keywords here to the Vitess side of reserved keywords. The reason is the following. The original bug here you reported is that the keyword is not escaped in the SQL that Vitess generates again. That is indeed since it doesn't know these as keywords.

But we don't need reserved keywords here, they can be non-reserved keywords. This is because these words won't cause any conflict in the grammar, so they don't need to be reserved. This way we don't break existing queries that use these keywords also for people who are not on MySQL 8.4, as we only have one grammar for all MySQL versions.

In the future we might also need to make it reserved once we add the actual parsing rules that use these keywords, but that would be a better time to also make them reserved because that at point there's actual feature support for something where it's needed.

@dbussink
Copy link
Contributor

It's not reserved, but it is a keyword, and it is missing from the generated test file.

Ah yes, that's because the current generated list here is from 8.0 (or 8.4 in this PR), where this isn't added yet. I think we're ok for now with that and can update it once we generate it with the first 9.x LTS version instead.

@dbussink
Copy link
Contributor

@L3o-pold Would have pushed the fix here, but I don't think that's allowed for the PR you opened here?

@L3o-pold
Copy link
Collaborator Author

@dbussink Github do not allow this for organisation fork. Do you mind creating your own PR and I close this one?

@dbussink
Copy link
Contributor

@dbussink Github do not allow this for organisation fork. Do you mind creating your own PR and I close this one?

See #17538

@dbussink dbussink closed this Jan 15, 2025
@L3o-pold L3o-pold deleted the mysql-84-reserved-keywords branch January 15, 2025 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug Report: InvalidArgument on MySQL 8.4 with manual column
3 participants