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

Foreign keys documentation #1604

Merged
merged 4 commits into from
Sep 29, 2023
Merged

Conversation

GuptaManan100
Copy link
Member

Description

This PR adds the docs for the foreign key work done so far as part of vitessio/vitess#12967

Signed-off-by: Manan Gupta <manan@planetscale.com>
Signed-off-by: Manan Gupta <manan@planetscale.com>
@netlify
Copy link

netlify bot commented Sep 27, 2023

Deploy Preview for vitess ready!

Name Link
🔨 Latest commit 1d25490
🔍 Latest deploy log https://app.netlify.com/sites/vitess/deploys/6516610b8214000008a68a7e
😎 Deploy Preview https://deploy-preview-1604--vitess.netlify.app/docs/18.0/user-guides/vschema-guide/foreign-keys
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Signed-off-by: Manan Gupta <manan@planetscale.com>

Users can run Vitess such that it doesn't know about or care for the foreign key constraints existing on MySQL. To run Vitess in this mode, `foreignKeyMode` VSchema property has to be set to `FK_UNMANAGED` for the given keyspace. This is the default mode for Vitess as well.

It is upto the users to configure the foreign keys in MySQL such that rows that are related by foreign keys end up living in the same shard.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
It is upto the users to configure the foreign keys in MySQL such that rows that are related by foreign keys end up living in the same shard.
It is up to the users to configure the foreign keys in MySQL such that rows that are related by foreign keys end up living in the same shard.

Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100 GuptaManan100 merged commit ba78b52 into vitessio:prod Sep 29, 2023
4 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.

3 participants