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

Materializer: normalize schema via schemadiff on --atomic-copy #14636

Merged
merged 2 commits into from
Nov 29, 2023

Conversation

shlomi-noach
Copy link
Contributor

Description

In materializer, and right now scoped to AtomicCopy operations only (just to keep the blast radius smaller for the time being), we normalize the source schema via schemadiff where possible. This ensures ordering of tables is compliant with any foreign key constraints. See #14635 for details.

Related Issue(s)

Fixes #14635

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

Copy link
Contributor

vitess-bot bot commented Nov 29, 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 29, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Nov 29, 2023
@@ -88,7 +88,7 @@ func TestFKWorkflow(t *testing.T) {
}
targetKeyspace := "fktarget"
targetTabletId := 200
vc.AddKeyspace(t, []*Cell{cell}, targetKeyspace, shardName, initialFKTargetVSchema, initialFKSchema, 0, 0, targetTabletId, sourceKsOpts)
vc.AddKeyspace(t, []*Cell{cell}, targetKeyspace, shardName, initialFKTargetVSchema, "", 0, 0, targetTabletId, sourceKsOpts)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This change to the test ensures the new behavior is applied. The schema in the test is composed of parent and child tables. Since child < parent lexicographically, the test fails without the new normalization.

@shlomi-noach shlomi-noach removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request labels Nov 29, 2023
log.Error(vterrors.Wrapf(err, "AtomicCopy: failed to normalize schema via schemadiff"))
} else {
applyDDLs = schema.ToQueries()
log.Infof("AtomicCopy used, and schema was normalized via schemadiff. New queries: %v", applyDDLs)
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we really want to always log this? As it can be a giant schema and thus a huge log entry?

sql := strings.Join(applyDDLs, ";\n")
log.Infof("materializer.deploySchema: sql=%v", sql)
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here, this can be very big and also would duplicate the logging.

Signed-off-by: Shlomi Noach <[email protected]>
@shlomi-noach shlomi-noach merged commit 5d49bf9 into vitessio:main Nov 29, 2023
116 checks passed
@shlomi-noach shlomi-noach deleted the materializer-normalize-schema branch November 29, 2023 12:20
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.

Materializer: need to normalize foreign key enabled schema before applying to target
3 participants