Skip to content

ApplySchema vttablet RPC: allow special characters in table and column names#13054

Merged
rohit-nayak-ps merged 1 commit intovitessio:mainfrom
planetscale:apply-schema-special-chars
May 28, 2023
Merged

ApplySchema vttablet RPC: allow special characters in table and column names#13054
rohit-nayak-ps merged 1 commit intovitessio:mainfrom
planetscale:apply-schema-special-chars

Conversation

@rohit-nayak-ps
Copy link
Copy Markdown
Member

@rohit-nayak-ps rohit-nayak-ps commented May 9, 2023 •
edited by mattlord
Loading

Description

VReplication MoveTables workflows which contain a table name or a column which has special characters (like ö or ü) are currently failing. While tracking down the issue it turned out that the target table/column names are being generated with incorrect character mappings.

Root Cause

VReplication uses the tabletmanagers ApplySchema RPC to copy over the schemas from the source to the target.

It turns out that ApplySchema executes the actual ddl using the mysql CLI in the mysqlctl package!! It is not clear why we are following this approach instead of directly creating it in the tablet like how OnlineDDL does it, for example: this code was added way back ~2016. It is possible this is legacy and can be refactored out.

This PR sets the default character set in the extra config that is passed on to the CLI ( --default-character-set=utf8mb4) command line argument. An existing e2e test has been updated to use special characters in both table and column names. It was failing before this change and passes with the change.

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

@rohit-nayak-ps
Set default characterset to be utf8mb4 while applying schemas so that…
a877da7 
… table and column names can have special characters

Signed-off-by: Rohit Nayak <rohit@planetscale.com>
@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels May 9, 2023
@vitess-bot
Copy link
Copy Markdown
Contributor

vitess-bot bot commented May 9, 2023

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • If this is a change that users need to know about, please apply the release notes (needs details) label so that merging is blocked unless the summary release notes document is included.
  • If a test is added or modified, there should be a documentation on top of the test to explain what the expected behavior is what the test does.

If a new flag is being introduced:

  • Is it really necessary to add this flag?
  • Flag names should be clear and intuitive (as far as possible)
  • Help text should be descriptive.
  • Flag names should use dashes (-) as word separators rather than underscores (_).

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow should be required, the maintainer team should be notified.

Bug fixes

  • There should be at least one unit or end-to-end test.
  • The Pull Request description should include a link to an issue that describes the bug.

Non-trivial changes

  • There should be some code comments as to why things are implemented the way they are.

New/Existing features

  • Should be documented, either by modifying the existing documentation or creating new documentation.
  • New features should have a link to a feature request issue or an RFC that documents the use cases, corner cases and test cases.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • vtctl command output order should be stable and awk-able.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from VTop, if used there.

@github-actions github-actions bot added this to the v17.0.0 milestone May 9, 2023
@rohit-nayak-ps rohit-nayak-ps changed the title WIP: ApplySchema vttablet RPC: allow special characters in table and column names ApplySchema vttablet RPC: allow special characters in table and column names May 9, 2023
@rohit-nayak-ps rohit-nayak-ps added Type: Bug Component: VReplication and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says Component: VReplication labels May 9, 2023
@rohit-nayak-ps rohit-nayak-ps marked this pull request as ready for review May 10, 2023 19:25
@rohit-nayak-ps rohit-nayak-ps requested a review from rsajwani as a code owner May 10, 2023 19:25
@rohit-nayak-ps rohit-nayak-ps removed the request for review from rsajwani May 10, 2023 19:26
mattlord
mattlord approved these changes May 10, 2023
View reviewed changes
@rohit-nayak-ps rohit-nayak-ps merged commit 726a165 into vitessio:main May 28, 2023
@rohit-nayak-ps rohit-nayak-ps deleted the apply-schema-special-chars branch May 28, 2023 08:14
@vitess-bot
Copy link
Copy Markdown
Contributor

vitess-bot bot commented May 28, 2023

I was unable to backport this Pull Request to the following branches: release-16.0.

@dbussink dbussink mentioned this pull request May 28, 2023
Merged
4 tasks
dbussink added a commit to dbussink/vitess that referenced this pull request Jun 16, 2023
@dbussink
mysqlctl: Use DBA connection for schema operations
c3fe116 
This was using the command line but we can use a proper mysql connection
here. Follow up to vitessio#13054 where this was identified.

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
dbussink added a commit that referenced this pull request Jun 17, 2023
@dbussink
mysqlctl: Use DBA connection for schema operations (#13178)
1b412e8 
This was using the command line but we can use a proper mysql connection
here. Follow up to #13054 where this was identified.

Signed-off-by: Dirkjan Bussink <d.bussink@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mattlord mattlord mattlord approved these changes

@dbussink dbussink Awaiting requested review from dbussink

@shlomi-noach shlomi-noach Awaiting requested review from shlomi-noach

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal

@GuptaManan100 GuptaManan100 Awaiting requested review from GuptaManan100

+1 more reviewer

@deepthi deepthi deepthi approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Component: VReplication Type: Bug

Projects

None yet

Milestone

v17.0.0

Development

Successfully merging this pull request may close these issues.

MoveTables workflow fails when table names or column names have special characters

4 participants

@rohit-nayak-ps @deepthi @mattlord @shlomi-noach