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

MoveTables Atomic Mode: set FK checks off while deploying schema on targets #15448

Conversation

rohit-nayak-ps
Copy link
Contributor

@rohit-nayak-ps rohit-nayak-ps commented Mar 11, 2024

Description

Previously schemadiff was conservative in detecting table cycles. It did not allow any two tables which had foreign key constraints pointing to each other, even though there were valid scenarios for this in MySQL. This was fixed in #15431.

However while deploying schemas on the target in MoveTables with atomic mode set, for such scenarios we need to set foreign_key_checks=0 since one of the tables being created will point to one being created in the future. This PR adds the ability to turn off fk constraint checks while deploying schemas, both for vtctlclient and vtctldclient and uses it during MoveTables Create --atomic-mode.

It extends one of the e2e tests which tests imports which use MoveTables for schemas with foreign keys to test this scenario.

Related Issue(s)

Follow-up to #15431 which fixes #15430.

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

Copy link
Contributor

vitess-bot bot commented Mar 11, 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 Mar 11, 2024
@github-actions github-actions bot added this to the v20.0.0 milestone Mar 11, 2024
@rohit-nayak-ps rohit-nayak-ps removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsWebsiteDocsUpdate What it says labels Mar 11, 2024
Copy link

codecov bot commented Mar 11, 2024

Codecov Report

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

Project coverage is 65.64%. Comparing base (2830a07) to head (eccec5b).
Report is 2 commits behind head on main.

❗ Current head eccec5b differs from pull request most recent head 2a9518d. Consider uploading reports for the commit 2a9518d to get more accurate results

Files Patch % Lines
go/vt/wrangler/materializer.go 0.00% 5 Missing ⚠️
go/vt/mysqlctl/schema.go 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15448      +/-   ##
==========================================
- Coverage   65.67%   65.64%   -0.04%     
==========================================
  Files        1563     1563              
  Lines      194380   194395      +15     
==========================================
- Hits       127658   127601      -57     
- Misses      66722    66794      +72     

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

Signed-off-by: Rohit Nayak <[email protected]>
Signed-off-by: Rohit Nayak <[email protected]>
@rohit-nayak-ps rohit-nayak-ps marked this pull request as ready for review March 11, 2024 22:13
@rohit-nayak-ps rohit-nayak-ps changed the title MoveTables Atomic Mode: set FK checks off while deploying schema on target on a Create MoveTables Atomic Mode: set FK checks off while deploying schema on targets Mar 11, 2024
Copy link
Contributor

@mattlord mattlord left a comment

Choose a reason for hiding this comment

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

LGTM! Just a couple of nits.

go/vt/mysqlctl/tmutils/schema.go Outdated Show resolved Hide resolved
@@ -193,8 +209,13 @@ func (ls *fkLoadSimulator) simulateLoad() {
default: // 20% chance to delete
ls.delete()
}
for _, table := range []string{"t11", "t12"} {
query := fmt.Sprintf("insert /*+ SET_VAR(foreign_key_checks=0) */ into fksource.%s values(%d, %d)", table, indexCounter, indexCounter)
Copy link
Contributor

Choose a reason for hiding this comment

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

Just noting that this will not work in 5.7, which I think is fine.

@@ -536,6 +536,10 @@ func (mysqld *Mysqld) ApplySchemaChange(ctx context.Context, dbName string, chan
sql = "SET sql_log_bin = 0;\n" + sql
}

if change.SetForeignKeyChecksOff {
sql = "SET foreign_key_checks = 0;\n" + sql
Copy link
Contributor

@mattlord mattlord Mar 11, 2024

Choose a reason for hiding this comment

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

This variable has a SESSION and GLOBAL context and value. IMO we should be explicit here and use session:

SET @@session.foreign_key_checks = 0;\n" + sql

https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_foreign_key_checks

Copy link
Contributor

Choose a reason for hiding this comment

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

The syntax, as it is, is setting the session value only. In MySQL, if neither session nor global is specified, then it is presumed to be session. For example:

> set read_only=1;
ERROR 1229 (HY000): Variable 'read_only' is a GLOBAL variable and should be set with SET GLOBAL

So I think it's fine to leave as it is.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, it’s not about the actual effect in 8.0 but rather being explicit about what your intention is.

Copy link
Contributor

Choose a reason for hiding this comment

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

What my thinking is, that as MySQL veterans this is explicit enough. It's common practice to say set foreign_key_checks=0 and it's clear that you're intent on modifying the session variable.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have the same opinion/reasoning as Shlomi

@@ -536,6 +536,10 @@ func (mysqld *Mysqld) ApplySchemaChange(ctx context.Context, dbName string, chan
sql = "SET sql_log_bin = 0;\n" + sql
}

if change.SetForeignKeyChecksOff {
sql = "SET foreign_key_checks = 0;\n" + sql
Copy link
Contributor

Choose a reason for hiding this comment

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

The syntax, as it is, is setting the session value only. In MySQL, if neither session nor global is specified, then it is presumed to be session. For example:

> set read_only=1;
ERROR 1229 (HY000): Variable 'read_only' is a GLOBAL variable and should be set with SET GLOBAL

So I think it's fine to leave as it is.

go/vt/mysqlctl/tmutils/schema.go Outdated Show resolved Hide resolved
Signed-off-by: Rohit Nayak <[email protected]>
@rohit-nayak-ps rohit-nayak-ps merged commit bdc138b into vitessio:main Mar 12, 2024
103 checks passed
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.

Feature Request: schemadiff & OnlineDDL: support valid foreign key table cycles
4 participants