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

VSchema DDL: Add grammar to accept qualified table names in Vindex option values #12577

Merged
merged 1 commit into from Mar 28, 2023

Conversation

hkdsun
Copy link
Member

@hkdsun hkdsun commented Mar 8, 2023

Description

In a similar spirit as #12519, we have run into another bug handling keyspace names with dashes - in them.

This time, while applying VSchema DDL statements such as:

ALTER VSCHEMA ON test2 
  ADD VINDEX test_lookup_fqn(c1,c2) 
  USING consistent_lookup_unique 
  WITH 
    owner=`test`, 
    from=`c1,c2`, 
    table=`test-keyspace`.`lookup-fqn`, 
    to=`keyspace_id`

Currently, the above is a syntax error, since everything after WITH is parsed as a reserved_sql_id/STRING/INTEGRAL.

This PR introduces table_id '.' reserved_table_id as valid syntax.

I chose this over a blanket table_name token since it's a narrower change, but I'm happy to go either way with it. We will be using fully-qualified table names with keyspace names.

Checklist

  • "Backport to:" labels have been added if this change should be back-ported
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI
  • Documentation was added or is not required

Deployment Notes

@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Mar 8, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Mar 8, 2023

Review Checklist

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

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

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

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

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

@hkdsun hkdsun changed the title Add grammar to accept qualified table names in VSchema DDL option values VSchema DDL: Add grammar to accept qualified table names in Vindex option values Mar 8, 2023
@hkdsun
Copy link
Member Author

hkdsun commented Mar 8, 2023

👋 This should not impact any reasonable existing usage of the VSchema DDL, and only fix a previously-broken syntax error. As such, I would like to kindly request a backport of this issue (similarly and perhaps bundle with #12519)

@hkdsun hkdsun removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Mar 8, 2023
@hkdsun
Copy link
Member Author

hkdsun commented Mar 23, 2023

If not the upcoming v15.0.3, we would love to have this merged and released in the next minor version 🙏

@GuptaManan100 GuptaManan100 removed the Backport This is a backport label Mar 27, 2023
@frouioui frouioui mentioned this pull request Mar 27, 2023
34 tasks
@frouioui
Copy link
Member

If not the upcoming v15.0.3, we would love to have this merged and released in the next minor version 🙏

I think this should be part of the upcoming v15.0.3 and v16.0.1.

Copy link
Member

@frouioui frouioui left a comment

Choose a reason for hiding this comment

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

Looks good to me, but I'll let @GuptaManan100 manan have a final say on the parser change.

The GH UI is telling me that there are some conflicts though: This branch has conflicts that must be resolved, would you mind fixing those?

@frouioui frouioui mentioned this pull request Mar 27, 2023
29 tasks
@hkdsun hkdsun force-pushed the vschema-ddl-table-escaping branch from 855520d to 7e23ac0 Compare March 27, 2023 15:00
@hkdsun
Copy link
Member Author

hkdsun commented Mar 27, 2023

Good morning/afternoon, thanks for taking a look and including this in the upcoming release!

I have fixed the merge conflict on the codegen file.

🤞 for CI

@frouioui
Copy link
Member

Hello @hkdsun, there are some more conflicts in sql.go. I am unable to push to your branch to solve those conflicts on GitHub. Can you resolve conflicts and push them? We'll try to merge your Pull Request as soon as possible to have enough time to merge its backports to our release branches.

Signed-off-by: Hormoz Kheradmand <hormoz.kheradmand@shopify.com>
@hkdsun hkdsun force-pushed the vschema-ddl-table-escaping branch from 7e23ac0 to cb7173c Compare March 28, 2023 11:02
@frouioui frouioui merged commit 21eaaa7 into vitessio:main Mar 28, 2023
112 checks passed
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Mar 28, 2023

I was unable to backport this Pull Request to the following branches: release-15.0, release-16.0.

frouioui pushed a commit to planetscale/vitess that referenced this pull request Mar 28, 2023
Signed-off-by: Hormoz Kheradmand <hormoz.kheradmand@shopify.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
frouioui pushed a commit to planetscale/vitess that referenced this pull request Mar 28, 2023
Signed-off-by: Hormoz Kheradmand <hormoz.kheradmand@shopify.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
rohit-nayak-ps pushed a commit that referenced this pull request Mar 29, 2023
Signed-off-by: Hormoz Kheradmand <hormoz.kheradmand@shopify.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: Hormoz Kheradmand <hkdsun@users.noreply.github.com>
rohit-nayak-ps pushed a commit that referenced this pull request Mar 29, 2023
Signed-off-by: Hormoz Kheradmand <hormoz.kheradmand@shopify.com>
Signed-off-by: Florent Poinsard <florent.poinsard@outlook.fr>
Co-authored-by: Hormoz Kheradmand <hkdsun@users.noreply.github.com>
@hmaurer hmaurer mentioned this pull request Mar 21, 2024
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.

None yet

3 participants