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

schemadiff: formalize SchemaDiff as the only schema diffing mechanism #12885

Merged
merged 4 commits into from
Apr 16, 2023

Conversation

shlomi-noach
Copy link
Contributor

Description

Followup to #12551
This PR hides the original Schema.Diff() function as Schema.diff(), leaving SchemaDiff() as the only mechanism for diffing two schemas.

The resulting SchemaDiff object offers these two public functions for getting the diffs:

  • OrderedDiffs(): typically this is what you want to use; a linearized slice of diffs, which are guaranteed to be conflict free and keep the schema valid at each step (a non-nil error is returned if it is impossible to get a conflict free list)
  • UnorderedDiffs(): a list of diffs - same diffs as above - but in non guaranteed and non-tested order. The order will work in the vast majority of cases and uses some basic heuristics. The use case for this function is for when the above OrderedDiffs() fails and one still wants to put their hands on a list of diffs.

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

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach shlomi-noach added Type: Enhancement Logical improvement (somewhere between a bug and feature) Component: Query Serving labels Apr 13, 2023
@shlomi-noach shlomi-noach requested a review from a team April 13, 2023 11:49
@vitess-bot vitess-bot bot added NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Apr 13, 2023
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Apr 13, 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 Apr 13, 2023
@shlomi-noach shlomi-noach removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says labels Apr 13, 2023
@shlomi-noach shlomi-noach requested a review from a team April 16, 2023 03:46
@deepthi deepthi merged commit ed72037 into vitessio:main Apr 16, 2023
@deepthi deepthi deleted the schemadiff-remove-schema-diff-func branch April 16, 2023 19:42
shlomi-noach added a commit to vitessio/website that referenced this pull request Apr 17, 2023
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
shlomi-noach added a commit to vitessio/website that referenced this pull request Apr 24, 2023
* blog post: schemadiff

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* more progress

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* push date

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* towards schemadiff blog

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* ongoing schemadiff blog content

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* content complete

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* remove duplicate intros

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* fixes per review

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* typo

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* grammar

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* minor improvements

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* minor rewording

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* Update content/en/blog/2023-04-15-schemadiff.md

Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* fixes per review

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* grammar: SQL diff

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* grammar

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* grammar

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* fixes per review

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* better example

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* clarify foreign key sentence

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* s/resolves/computes

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* publish date

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* publish date

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* adapt to changes in vitessio/vitess#12885

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

* removed old entry

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

---------

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Co-authored-by: Deepthi Sigireddi <deepthi@planetscale.com>
frouioui pushed a commit to planetscale/vitess that referenced this pull request Nov 21, 2023
…nly schema diffing mechanism (vitessio#1923)

* cherry pick of 12885

* empty commit to kick CI

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>

---------

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Co-authored-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Query Serving Type: Enhancement Logical improvement (somewhere between a bug and feature)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants