Skip to content

schemadiff: RelatedForeignKeyTables()#18195

Merged
harshit-gangal merged 2 commits intovitessio:mainfrom
planetscale:schemadiff-diff-affects-fk
Jul 16, 2025
Merged

schemadiff: RelatedForeignKeyTables()#18195
harshit-gangal merged 2 commits intovitessio:mainfrom
planetscale:schemadiff-diff-affects-fk

Conversation

@shlomi-noach
Copy link
Contributor

@shlomi-noach shlomi-noach commented Apr 23, 2025

Description

The SchemaDiff result now supplies an RelatedForeignKeyTables() function that lists all foreign key tables that are either explicitly or implicitly affected by the diff. This means:

  • Tables that are directly created, altered, dropped by the change, and have foreign key constraints
  • Tables that are referencing a table that is created, altered, dropped by the change
  • Tables that are referenced by a created, altered, dropped table in the change

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

Deployment Notes

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: schema management schemadiff and schema changes labels Apr 23, 2025
@shlomi-noach shlomi-noach requested a review from a team April 23, 2025 08:40
@shlomi-noach shlomi-noach requested a review from mattlord as a code owner April 23, 2025 08:40
@vitess-bot
Copy link
Contributor

vitess-bot bot commented Apr 23, 2025

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 Apr 23, 2025
@github-actions github-actions bot added this to the v23.0.0 milestone Apr 23, 2025
@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 NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Apr 23, 2025
@codecov
Copy link

codecov bot commented Apr 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.56%. Comparing base (673e0d3) to head (7a6ec26).
Report is 81 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #18195      +/-   ##
==========================================
+ Coverage   67.54%   67.56%   +0.01%     
==========================================
  Files        1601     1601              
  Lines      261484   261502      +18     
==========================================
+ Hits       176612   176674      +62     
+ Misses      84872    84828      -44     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Signed-off-by: Shlomi Noach <2607934+shlomi-noach@users.noreply.github.com>
@shlomi-noach shlomi-noach changed the title schemadiff: AffectedForeignKeyTables() schemadiff: RelatedForeignKeyTables() Apr 23, 2025
@shlomi-noach shlomi-noach requested review from a team and dbussink April 29, 2025 07:55
@github-actions
Copy link
Contributor

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. and removed Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. labels May 30, 2025
@github-actions
Copy link
Contributor

This PR is being marked as stale because it has been open for 30 days with no activity. To rectify, you may do any of the following:

  • Push additional commits to the associated branch.
  • Remove the stale label.
  • Add a comment indicating why it is not stale.

If no action is taken within 7 days, this PR will be closed.

@github-actions github-actions bot added Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. and removed Stale Marks PRs as stale after a period of inactivity, which are then closed after a grace period. labels Jun 30, 2025
@harshit-gangal harshit-gangal merged commit 9c5d552 into vitessio:main Jul 16, 2025
103 of 104 checks passed
@harshit-gangal harshit-gangal deleted the schemadiff-diff-affects-fk branch July 16, 2025 16:29
morgo added a commit to morgo/vitess that referenced this pull request Jul 21, 2025
* origin/master:
  bugfix: Fix impossible query for UNION (vitessio#18463)
  fix topo use in local_example (vitessio#18357)
  fix: update go-upgrade tool to check patch number (vitessio#18252) (vitessio#18402)
  Update MAINTAINERS.md and CODEOWNERS (vitessio#18462)
  Add logging to binlog watcher actions (vitessio#18264)
  `schemadiff`: `RelatedForeignKeyTables()` (vitessio#18195)
  `vtorc`: allow recoveries to be disabled from startup (vitessio#18005)
  Fix `vttablet` not being marked as not serving when MySQL stalls (vitessio#17883)
  make xtrabackup ShouldDrainForBackup configurable (vitessio#18431)
  Reset in-memory sequence info on vttablet on UpdateSequenceTables request (vitessio#18415)
  Fix watcher storm during topo outages (vitessio#18434)
  Online DDL: resume vreplication after cut-over/RENAME failure (vitessio#18428)
  Online DDL cutover enhancements (vitessio#18423)
  VStreamer: change in filter logic (vitessio#18319)
  Online DDL metrics: `OnlineDDLStaleMigrationMinutes` (vitessio#18417)

Signed-off-by: Morgan Tocker <tocker@gmail.com>
morgo added a commit to morgo/vitess that referenced this pull request Jul 29, 2025
…rds-new2

* origin/master:
  bugfix: Fix impossible query for UNION (vitessio#18463)
  fix topo use in local_example (vitessio#18357)
  fix: update go-upgrade tool to check patch number (vitessio#18252) (vitessio#18402)
  Update MAINTAINERS.md and CODEOWNERS (vitessio#18462)
  Add logging to binlog watcher actions (vitessio#18264)
  `schemadiff`: `RelatedForeignKeyTables()` (vitessio#18195)
  `vtorc`: allow recoveries to be disabled from startup (vitessio#18005)
  Fix `vttablet` not being marked as not serving when MySQL stalls (vitessio#17883)
  make xtrabackup ShouldDrainForBackup configurable (vitessio#18431)

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

Labels

Component: schema management schemadiff and schema changes Type: Enhancement Logical improvement (somewhere between a bug and feature)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants