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

update the foreign key feature description #15736

Merged
merged 3 commits into from
Dec 18, 2023
Merged

update the foreign key feature description #15736

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf7efa4
Update foreign-key.md
qiancai Dec 15, 2023
243658f
Update foreign-key.md
qiancai Dec 15, 2023
d070558
Update foreign-key.md
qiancai Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion foreign-key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Starting from v6.6.0, TiDB supports the foreign key feature, which allows cross-
> **Warning:**
>
> - Currently, the foreign key feature is experimental. It is not recommended that you use it in production environments. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub.
> - The foreign key feature is usually used for providing integrity and consistency constraint checks for data in small or medium volumes. However, for large data volumes in a distributed database system, the use of foreign keys might lead to serious performance issues and could have unpredictable effects on the system. If you plan to use foreign keys, conduct thorough validation first and use them with caution.
> - The foreign key feature is typically employed to enforce [referential integrity](https://en.wikipedia.org/wiki/Referential_integrity) constraint checks. It might introduce performance degradation, so it is recommended to conduct thorough testing before using it in performance-sensitive scenarios.
qiancai marked this conversation as resolved.
Show resolved Hide resolved

The foreign key is defined in the child table. The syntax is as follows:

Expand Down
Loading