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: Qualify and SQL escape tables in created AutoIncrement VSchema definitions #17174

Merged
merged 4 commits into from
Nov 7, 2024

Conversation

mattlord
Copy link
Contributor

@mattlord mattlord commented Nov 7, 2024

Description

This is a follow-up to #16860 that addresses a couple of potential edge cases when we automatically replace the auto increment handling:

  1. The sequence table name in the VSchema AutoIncrement definition needs to be SQL escaped as it contains e.g. dashes
  2. The sequence table name is not unique across the Vitess cluster

This PR addresses those respectively by 1) ensuring that the sequence table name is always properly SQL escaped 2) qualifying the sequence table with the keyspace and ensuring that the keyspace name is also properly SQL escaped.

I think that we should backport this to v21 as it heads off potential bugs related to keyspaces and table names that must be SQL escaped along with potential bugs related to the non-qualified generated sequence names NOT being unique across all keyspaces in the Vitess cluster.

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

…keyspace

Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Matt Lord <mattalord@gmail.com>
Copy link
Contributor

vitess-bot bot commented Nov 7, 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 NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Nov 7, 2024
@github-actions github-actions bot added this to the v22.0.0 milestone Nov 7, 2024
@mattlord mattlord changed the title VReplication: Qualify created sequence tables VReplication: Qualify and SQL escape table references in auto-created AutoIncrement VSchema definitions Nov 7, 2024
@mattlord mattlord changed the title VReplication: Qualify and SQL escape table references in auto-created AutoIncrement VSchema definitions VReplication: Qualify and SQL escape tables in auto-created AutoIncrement VSchema definitions Nov 7, 2024
@mattlord mattlord added Backport to: release-21.0 Needs to be backport to release-21.0 and removed NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Nov 7, 2024
Copy link

codecov bot commented Nov 7, 2024

Codecov Report

Attention: Patch coverage is 60.00000% with 10 lines in your changes missing coverage. Please review.

Project coverage is 67.44%. Comparing base (9946ce8) to head (80745b4).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
go/vt/vtctl/workflow/materializer.go 64.70% 6 Missing ⚠️
go/vt/vtctl/workflow/utils.go 50.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #17174      +/-   ##
==========================================
- Coverage   67.45%   67.44%   -0.02%     
==========================================
  Files        1569     1569              
  Lines      252229   252244      +15     
==========================================
- Hits       170150   170124      -26     
- Misses      82079    82120      +41     

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

@mattlord mattlord added Type: Bug Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: VReplication and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work labels Nov 7, 2024
@mattlord mattlord changed the title VReplication: Qualify and SQL escape tables in auto-created AutoIncrement VSchema definitions VReplication: Qualify and SQL escape tables in created AutoIncrement VSchema definitions Nov 7, 2024
@mattlord mattlord force-pushed the qualify_created_seq_tables branch from a39994d to b286043 Compare November 7, 2024 18:39
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord force-pushed the qualify_created_seq_tables branch from b286043 to 4ceed1c Compare November 7, 2024 18:41
if err != nil {
return err
}
seqTableName = fmt.Sprintf("%s.%s", seqKeyspace, seqTableName)
Copy link
Contributor

Choose a reason for hiding this comment

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

🥳

@mattlord mattlord removed the Type: Enhancement Logical improvement (somewhere between a bug and feature) label Nov 7, 2024
@mattlord mattlord marked this pull request as ready for review November 7, 2024 19:02
Signed-off-by: Matt Lord <mattalord@gmail.com>
@mattlord mattlord merged commit 31b956b into vitessio:main Nov 7, 2024
98 checks passed
@mattlord mattlord deleted the qualify_created_seq_tables branch November 7, 2024 20:29
mattlord added a commit that referenced this pull request Nov 8, 2024
… AutoIncrement VSchema definitions (#17174) (#17176)

Signed-off-by: Matt Lord <mattalord@gmail.com>
Co-authored-by: vitess-bot[bot] <108069721+vitess-bot[bot]@users.noreply.github.com>
Co-authored-by: Matt Lord <mattalord@gmail.com>
rvrangel pushed a commit to rvrangel/vitess that referenced this pull request Nov 21, 2024
…VSchema definitions (vitessio#17174)

Signed-off-by: Matt Lord <mattalord@gmail.com>
Signed-off-by: Renan Rangel <rrangel@slack-corp.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: qualify generated sequence table name
4 participants