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

schemadiff: Fix handling of primary key #11059

Conversation

dbussink
Copy link
Contributor

This fixes the handling of primary key options. When dropping a primary key, we should use drop primary key and not use the name.

Related Issue(s)

#10203

Checklist

  • "Backport me!" label has been added if this change should be backported
  • Tests were added or are not required
  • Documentation was added or is not required

This fixes the handling of primary key options. When dropping a primary
key, we should use `drop primary key` and not use the name.

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
@dbussink dbussink requested a review from shlomi-noach August 21, 2022 18:42
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Aug 21, 2022

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 new flag is being introduced, review whether it is really needed. The flag names should be clear and intuitive (as far as possible), and the flag's help should be descriptive. Additionally, flag names should use dashes (-) as word separators rather than underscores (_).
  • If a workflow is added or modified, each items in Jobs should be named in order to mark it as required. If the workflow should be required, the GitHub Admin should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should either include a link to an issue that describes the bug OR an actual description of the bug and how to reproduce, along with a description of the fix.

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.

dropKey := &sqlparser.DropKey{}
if strings.EqualFold(dropKey.Name.String(), "PRIMARY") {
if strings.EqualFold(info.Type, sqlparser.PrimaryKeyTypeStr) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This wasn't even checking anything at all. It checked the name of dropKey but that was just initialized to a new struct so this check would never be true at all. By passing in the more details from info we can check the actual type.

@@ -1631,7 +1631,15 @@ func (c *CreateTableEntity) apply(diff *AlterTableEntityDiff) error {
// we expect the named key to be found
found := false
switch opt.Type {
case sqlparser.NormalKeyType, sqlparser.PrimaryKeyType:
case sqlparser.PrimaryKeyType:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This should be handled separately since we want to check the type in this case, not the name. There's only one primary key anyway so we need to find that.

@shlomi-noach
Copy link
Contributor

When dropping a primary key, we should use drop primary key and not use the name.

The statement alter table tpk1 drop key primary; is valid in MySQL and is equivalent to alter table tpk1 drop primary key. Is there a particular reason why we have to use the 2nd form?

@dbussink
Copy link
Contributor Author

The statement alter table tpk1 drop key primary; is valid in MySQL and is equivalent to alter table tpk1 drop primary key. Is there a particular reason why we have to use the 2nd form?

Ah ok, I had no idea tbh that that worked at all 🤦. Never seen the syntax, always see drop primary key, I guess that's why I looked at changing it to the second form.

If we want to keep the existing though, we still have an issue I think since #11059 (comment) seems like it would be wrong still since dropKey is new and it would never match PRIMARY there anyway? That additionally confused me and made me think this was wrong.

@dbussink dbussink added Type: Enhancement Logical improvement (somewhere between a bug and feature) and removed Type: Bug labels Aug 21, 2022
@shlomi-noach
Copy link
Contributor

Yeah, so the name of the PRIMARY KEY is "PRIMARY" and the name can be used like any other key. Definitely agree that #11059 (comment) is trivially a bug. Also agree that DROP PRIMARY KEY is the more commonly known syntax.

@shlomi-noach shlomi-noach merged commit 3e9881d into vitessio:main Aug 22, 2022
@shlomi-noach shlomi-noach deleted the dbussink/fix-schemadiff-primary-key-handling branch August 22, 2022 05:37
notfelineit pushed a commit to planetscale/vitess that referenced this pull request Sep 21, 2022
This fixes the handling of primary key options. When dropping a primary
key, we should use `drop primary key` and not use the name.

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Query Serving Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants