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

VReplication: Remove auto_increment clauses for MoveTables to a sharded keyspace #15679

Merged
merged 12 commits into from
Apr 9, 2024

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Apr 8, 2024

Description

It's common to move one or more tables from an unsharded keyspace to a sharded one as a subset of tables become too large and must be split — or when moving tables from a standalone MySQL instance to Vitess and sharding them in the process.

For unsharded tables it's standard to use MySQL's auto_increment feature so that a unique Primary Key value is automatically generated and assigned for each row. Once those tables are sharded, however, you DO NOT typically want to use them as each row needs to be unique across ALL shards rather than within a single MySQL instance/shard. You should instead use something generated externally such as some form of a globally/universally unique identifier or Vitess Sequences.

Given this explicit best practice, we should perform this work for you automatically within Vitess by default (with the ability to opt-out) when moving tables from an unsharded keyspace to a sharded one. This avoids potential mistakes down the line (something that does a direct insert in the mysqld instance w/o providing a PK value, expecting a unique one to be generated when it's not) and prevents the user from having to perform other perhaps heavy manual operations such as later running an ALTER TABLE on the tables.

ℹ️ This feature is ONLY added to the vtctldclient implementation while the legacy vtctlclient implementation is left alone so that it can remain frozen and serve as a backup in case an unexpected edge case is encountered with the new client — until it's later removed.

Related Issue(s)

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

@mattlord mattlord added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VReplication labels Apr 8, 2024
Copy link
Contributor

vitess-bot bot commented Apr 8, 2024

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 labels Apr 8, 2024
@vitess-bot vitess-bot bot added NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Apr 8, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Apr 8, 2024
@mattlord mattlord removed NeedsWebsiteDocsUpdate What it says NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Apr 8, 2024
Copy link

codecov bot commented Apr 8, 2024

Codecov Report

Attention: Patch coverage is 77.27273% with 5 lines in your changes are missing coverage. Please review.

Project coverage is 68.37%. Comparing base (ffa21e7) to head (306d6ee).
Report is 2 commits behind head on main.

Files Patch % Lines
go/vt/vtctl/workflow/materializer.go 50.00% 5 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main   #15679   +/-   ##
=======================================
  Coverage   68.37%   68.37%           
=======================================
  Files        1556     1556           
  Lines      195051   195120   +69     
=======================================
+ Hits       133365   133416   +51     
- Misses      61686    61704   +18     

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

@mattlord mattlord removed the NeedsIssue A linked issue is missing for this Pull Request label Apr 8, 2024
@mattlord mattlord changed the title VReplication: Remove auto-increment clauses for MoveTables to a sharded keyspace VReplication: Remove auto_increment clauses for MoveTables to a sharded keyspace Apr 8, 2024
@mattlord mattlord removed the NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work label Apr 8, 2024
@mattlord mattlord marked this pull request as ready for review April 8, 2024 18:40
@mattlord mattlord requested review from shlomi-noach and removed request for deepthi and ajm188 April 8, 2024 18:40
Signed-off-by: Matt Lord <[email protected]>
Signed-off-by: Matt Lord <[email protected]>
Copy link
Contributor

@shlomi-noach shlomi-noach 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! One nit ask for a test change.

return true
}

noAutoIncAST := sqlparser.Rewrite(ast, stripAutoIncrement, nil)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think it would have been easier to use Walk(), to jump right into a Column definition, but it's fine as it is.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Perfect!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: VReplication Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Feature Request: Drop auto_increment from sharded column definitions on MoveTables Create
4 participants