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.

Sign up for GitHub

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

Jump to bottom

schemadiff: remove table name from auto-generated FK constraint name #14385

Merged
merged 4 commits into from
Oct 29, 2023
Merged

schemadiff: remove table name from auto-generated FK constraint name #14385

merged 4 commits into from
Oct 29, 2023

Conversation

shlomi-noach
Copy link
Contributor

Description

Similarly to #10638, this PR removes the table name from auto-generated foreign key constraint names. The reason is that due to MySQL behavior, when you RENAME TABLE t TO something_else, all auto-generated constraints names, including foreign key names, are likewise renamed. In the above example, that means the constraint name length increases by 13 characters. With Vitess internal names that easily risks running out of constraint name allowed length (64 characters), which in turn fails the RENAME.

The existing code was already meant to deal with the situation, but by mistake used fk, rather than ibfk, as the indicator for auto-generated names.

Related Issue(s)

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

@shlomi-noach shlomi-noach added Type: Bug Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Online DDL Online DDL (vitess/native/gh-ost/pt-osc) labels Oct 29, 2023
@shlomi-noach shlomi-noach requested a review from a team October 29, 2023 04:35
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Oct 29, 2023

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 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 Oct 29, 2023
@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 labels Oct 29, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Oct 29, 2023
dbussink
dbussink reviewed Oct 29, 2023
View reviewed changes
go/vt/schemadiff/names.go
@@ -42,6 +42,9 @@ func ExtractConstraintOriginalName(tableName string, constraintName string) stri
if strings.HasPrefix(constraintName, fmt.Sprintf("%s_fk_", tableName)) {
return constraintName[len(tableName)+1:]
}
if strings.HasPrefix(constraintName, fmt.Sprintf("%s_ibfk_", tableName)) {
return constraintName[len(tableName)+1:]
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need the case above this one still? Since that’s not what the automatic names look like?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll remove it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed.

@shlomi-noach
remove earlier '_fk' indicator; it was wrong to use it, as MySQL uses…
6369661 
… '_ibfk'

Signed-off-by: Shlomi Noach <[email protected]>
@shlomi-noach
adapt tests
f8d5754 
Signed-off-by: Shlomi Noach <[email protected]>
@shlomi-noach
adapt tests
800232f 
Signed-off-by: Shlomi Noach <[email protected]>
@shlomi-noach shlomi-noach requested a review from a team October 29, 2023 11:02
@dbussink dbussink merged commit dde1939 into vitessio:main Oct 29, 2023
115 checks passed
@dbussink dbussink deleted the schemadiff-generalize-constraint-names branch October 29, 2023 14:31
@shlomi-noach shlomi-noach mentioned this pull request Oct 29, 2023
Merged
@shlomi-noach shlomi-noach mentioned this pull request Nov 13, 2023
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rohit-nayak-ps rohit-nayak-ps rohit-nayak-ps approved these changes

@dbussink dbussink dbussink approved these changes

@mattlord mattlord Awaiting requested review from mattlord mattlord is a code owner

@deepthi deepthi Awaiting requested review from deepthi

Assignees
No one assigned
Labels
Component: Online DDL Online DDL (vitess/native/gh-ost/pt-osc) Type: Bug Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Milestone
v19.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@shlomi-noach @dbussink @rohit-nayak-ps