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

Online DDL: edit CONSTRAINT names in CREATE TABLE #14517

Merged
merged 3 commits into from
Nov 15, 2023

Conversation

shlomi-noach
Copy link
Contributor

Description

Followup to #10638 and #14385, this PR edits a CREATE TABLE statement, to remove the table-name prefix from existing constraint names. This is so as to make the constraint name a non-generated one. The reasoning is to avoid https://bugs.mysql.com/bug.php?id=107772

e.g. if some issues:

vtctldclient ApplySchema --ddl_strategy="vitess" --sql "create table mytable (id int primary key, check ((id >= 0)))" commerce

Then MySQL auto generates a constraint name, and the CREATE TABLE statement becomes:

CREATE TABLE `mytable` (
  `id` int NOT NULL,
  PRIMARY KEY (`id`),
  CONSTRAINT `mytable_chk_1` CHECK ((`id` >= 0))
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci

However, Online DDL intercepts the name mytable_chk_1, identifies that it begins with mytable_chk_, and converts it to something like chk_crq6muar52qehxxi5wmd4fj5y.

Related Issue(s)

https://bugs.mysql.com/bug.php?id=107772

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 Nov 13, 2023
@shlomi-noach shlomi-noach requested a review from a team November 13, 2023 19:23
Copy link
Contributor

vitess-bot bot commented Nov 13, 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 Nov 13, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Nov 13, 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 Nov 13, 2023
newCreateTable := sqlparser.CloneRefOfCreateTable(originalCreateTable)
// Rewrite this CREATE TABLE statement such that CONSTRAINT names are edited,
// specifically removing any <tablename> prefix.
if _, err := e.validateAndEditCreateTableStatement(ctx, onlineDDL, newCreateTable); err != nil {
Copy link
Member

Choose a reason for hiding this comment

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

unrelated to this PR, but why do we pass a context to this function? Functions that don't perform RPCs do not need to take in a context.

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 specific function indeed doesn't use the given context. There's many other non-gRPC functions that do use a context because they either use a Connection (context cancellation ensures connection terminates) or loops/waits.

@shlomi-noach shlomi-noach merged commit 024af93 into vitessio:main Nov 15, 2023
115 checks passed
@shlomi-noach shlomi-noach deleted the fk-names-create-table branch November 15, 2023 04:38
ejortegau pushed a commit to slackhq/vitess that referenced this pull request Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

3 participants