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

New unified internal table names format, part 1: identifying and accepting new format tables #14613

Merged

Conversation

shlomi-noach
Copy link
Contributor

@shlomi-noach shlomi-noach commented Nov 27, 2023

Description

See story in #14582

We introduce a new unified internal table name format, which is consistent 56 characters long, and includes a human readable UUID, human readable timestamp, and a table purpose hint. Example name:

_vt_hld_6ace8bcef73211ea87e9f875a4d24e90_20200915120410_

The name still has room to spare to add default MySQL constraint names, such as _ibfk_12 (totaling 64 characters as in _vt_hld_6ace8bcef73211ea87e9f875a4d24e90_20200915120410__ibfk_12).

In this PR Vitess recognizes tables in the new format alongside the old format. Table lifecycle is the single sensitive consumer of table names, because the name of a table indicates its GC state, and the transition and timing of the transition into the next state. Table lifecycle now identifies both formats, e.g. both:

  • _vt_DROP_6ace8bcef73211ea87e9f875a4d24e90_20200915120410
  • _vt_drp_6ace8bcef73211ea87e9f875a4d24e90_20200915120410_

...indicate the exact same table state and are interpreted in an identical manner.

Online DDL, vreplication, etc., all implicitly become aware of the new format.

However, nothing outside tests actually generates tables in the new format. For backwards compatibility purposes that can only take place in v20, while this PR is expected to be included in v19.

For the next two Vitess versions, there will be some duality. e.g. these two functions:

  • schema.GenerateRenameStatement(...)
  • schema.GenerateRenameStatementNewFormat(...)

and others, work almost exactly the same name, but using old/new formats.

In v20 and v21 we can remove the duality, and eventually get rid of old format related code.

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

…(v19), the new format is accepted and recognized, but never generated. Names will be generated with the new format starting v20

Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Signed-off-by: Shlomi Noach <[email protected]>
Copy link
Contributor

vitess-bot bot commented Nov 27, 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 27, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Nov 27, 2023
@shlomi-noach
Copy link
Contributor Author

Since this PR does not actually introduce table names, it does not require doc changes. We might want to add a preliminary comment in our docs about the expected new format, is all. Keeping the NeedsWebsiteDocsUpdate label for now.

@shlomi-noach shlomi-noach removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request labels Nov 27, 2023
Signed-off-by: Shlomi Noach <[email protected]>
@shlomi-noach
Copy link
Contributor Author

Documentation PR: vitessio/website#1661

@shlomi-noach shlomi-noach removed the NeedsWebsiteDocsUpdate What it says label Jan 11, 2024
@shlomi-noach shlomi-noach merged commit edce68b into vitessio:main Jan 11, 2024
99 of 100 checks passed
@shlomi-noach shlomi-noach deleted the unify-internal-vitess-table-names-part1 branch January 11, 2024 06:33
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.

3 participants