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.

Sign up for GitHub

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

Jump to bottom

Update Cascade Planning leading to Foreign key constraint verification #13902

Merged
merged 15 commits into from
Sep 8, 2023
Merged

Update Cascade Planning leading to Foreign key constraint verification #13902

merged 15 commits into from
Sep 8, 2023

Conversation

GuptaManan100
Copy link
Member

@GuptaManan100 GuptaManan100 commented Aug 31, 2023 •
edited by harshit-gangal
Loading

Description

This PR adds two planning support

  • FK Cascade that validates that value exists on the parent table.
  • FK Restrict that validates that the value does not exist on the child table.

Related Issue(s)

Checklist

  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on the CI

@vitess-bot
Copy link
Contributor

vitess-bot bot commented Aug 31, 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 Aug 31, 2023
@github-actions github-actions bot added this to the v18.0.0 milestone Aug 31, 2023
@harshit-gangal harshit-gangal added Type: Feature Component: Query Serving and 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 Sep 5, 2023
@harshit-gangal harshit-gangal marked this pull request as ready for review September 6, 2023 04:54
harshit-gangal
harshit-gangal reviewed Sep 7, 2023
View reviewed changes
go/vt/vtgate/planbuilder/operators/ast_to_update_op.go
Comment on lines +494 to +497
// Each child foreign key constraint is verified by a join query of the form:
// select 1 from child_tbl join parent_tbl on <columns in fk> where <clause same as original update> limit 1
// E.g:
// Child (c1, c2) references Parent (p1, p2)
// update Parent set p1 = 1 where id = 1
// verify query:
// select 1 from Child join Parent on Parent.p1 = Child.c1 and Parent.p2 = Child.c2
// where Parent.id = 1 limit 1
func createFkVerifyOpForChildFKForUpdate(ctx *plancontext.PlanningContext, updStmt *sqlparser.Update, cFk vindexes.ChildFKInfo) (ops.Operator, error) {
// ON UPDATE RESTRICT foreign keys that require validation, should only be allowed in the case where we
Copy link
Member

Choose a reason for hiding this comment

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

we should not fail the verify when updating to the same value.

@harshit-gangal harshit-gangal changed the title Fk verify update planning Update Cascade Planning leading to Foreign key constraint verification Sep 7, 2023
systay
systay reviewed Sep 8, 2023
View reviewed changes
go/vt/vtgate/planbuilder/testdata/foreignkey_cases.json Outdated
{
"comment": "update with fk on cross-shard with a where condition on non-literal value - disallowed",
"query": "update tbl3 set coly = colx + 10 where coly = 10",
"plan": "VT12001: unsupported: foreign keys management at vitess with non-literal values"
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think we can come up with a better error message for this limitation. this one is a little hard to decipher, imho

harshit-gangal and others added 6 commits September 8, 2023 16:56
@harshit-gangal
add support for foreign key constraint verify on update
8bbe0dc 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@GuptaManan100 @harshit-gangal
refactor: add comment explaining map in input
9511c41 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@harshit-gangal
foreign key verify operator and logical
ff8b2ce 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal
changed parent verification query and accordingly change the engine p…
f1d720c 
…rimitive for foreign key constraint verification

Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal
add where condition to fk verify query
6ccc138 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@GuptaManan100 @harshit-gangal
feat: add code to verify update with cascade run with foreign key che…
0c36809 
…cks 0 and validate all the foreign keys on vtgate

Signed-off-by: Manan Gupta <manan@planetscale.com>
GuptaManan100 and others added 8 commits September 8, 2023 16:56
@GuptaManan100 @harshit-gangal
test: fix tests to reflect the recent changes
b91b206 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100 @harshit-gangal
feat: add code to verify valdity of ON UPDATE RESTRICT foreign keys w…
89437e6 
…herever required

Signed-off-by: Manan Gupta <manan@planetscale.com>
@harshit-gangal
small refactor
0981e59 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal
update plan output test
d1d9906 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal
store the verification type
d0f8352 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal
return verify error based on type
f232f6b 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal
small refactor - removed unused code
2adba03 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal
cascade with new value should work
fa6f6d1 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal harshit-gangal force-pushed the fk-verify-update-planning branch from b81e8e2 to fa6f6d1 Compare September 8, 2023 16:15
@harshit-gangal
update fk error messages
c301cdc 
Signed-off-by: Harshit Gangal <harshit@planetscale.com>
@harshit-gangal harshit-gangal merged commit ee77f54 into vitessio:main Sep 8, 2023
@harshit-gangal harshit-gangal deleted the fk-verify-update-planning branch September 8, 2023 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@harshit-gangal harshit-gangal harshit-gangal approved these changes

@systay systay systay approved these changes

@frouioui frouioui Awaiting requested review from frouioui frouioui is a code owner

@arthurschreiber arthurschreiber Awaiting requested review from arthurschreiber arthurschreiber is a code owner

Assignees
No one assigned
Labels
Component: Query Serving Type: Feature
Projects
None yet
Milestone
v18.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@GuptaManan100 @systay @harshit-gangal