sqlite: enable foreign key constraints by default #54777
Merged
+78
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
For historical reasons and to maintain compatibibility with legacy
database schemas, SQLite does not enable foreign key constraints by
default. For new applications, however, this behavior is undesirable.
Currently, any application that wishes to use foreign keys must use
PRAGMA foreign_keys = ON;
to explicitly enable enforcement of such constraints.
This commit changes the behavior of the SQLite API built into Node.js
to enable foreign key constraints by default. This behavior can be
overridden by users to maintain compatibility with legacy database
schemas.
nodejs-github-bot
added
c++
anonrig
approved these changes
Sep 4, 2024
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #54777 +/- ##
==========================================
- Coverage 87.62% 87.61% -0.02%
==========================================
Files 650 650
Lines 182878 182957 +79
Branches 35387 35403 +16
==========================================
+ Hits 160242 160289 +47
- Misses 15921 15923 +2
- Partials 6715 6745 +30
|
atlowChemi
approved these changes
Sep 5, 2024
targos
approved these changes
Sep 5, 2024
cjihrig
approved these changes
Sep 5, 2024
|
I personally don't think so. WAL mode is often preferable but also has significant disadvantages, and the SQLite developers recommend adjusting other configuration options as well when using WAL mode (e.g., |
jasnell
reviewed
Sep 5, 2024
| @@ -21,7 +21,8 @@ class DatabaseSync : public BaseObject { | |||
| DatabaseSync(Environment* env, | |||
| v8::Local<v8::Object> object, | |||
| v8::Local<v8::String> location, | |||
| bool open); | |||
| bool open, | |||
| bool enable_foreign_keys_on_open); | |||
There was a problem hiding this comment.
non-blocking nit: totally not a fan of bool arguments like this. Would much prefer having either an options struct or enums for this purpose.
There was a problem hiding this comment.
@jasnell I agree, I am planning to add at least one more option and to then wrap the *_on_open options in a struct.
jasnell
approved these changes
Sep 5, 2024
github-actions
bot
removed
the
request-ci
tniessen
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
Landed in a49abec |
aduh95
pushed a commit
that referenced
this pull request
Oct 9, 2024
For historical reasons and to maintain compatibibility with legacy
database schemas, SQLite does not enable foreign key constraints by
default. For new applications, however, this behavior is undesirable.
Currently, any application that wishes to use foreign keys must use
PRAGMA foreign_keys = ON;
to explicitly enable enforcement of such constraints.
This commit changes the behavior of the SQLite API built into Node.js
to enable foreign key constraints by default. This behavior can be
overridden by users to maintain compatibility with legacy database
schemas.
PR-URL: #54777
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
louwers
added a commit
to louwers/node
that referenced
this pull request
Nov 2, 2024
For historical reasons and to maintain compatibibility with legacy
database schemas, SQLite does not enable foreign key constraints by
default. For new applications, however, this behavior is undesirable.
Currently, any application that wishes to use foreign keys must use
PRAGMA foreign_keys = ON;
to explicitly enable enforcement of such constraints.
This commit changes the behavior of the SQLite API built into Node.js
to enable foreign key constraints by default. This behavior can be
overridden by users to maintain compatibility with legacy database
schemas.
PR-URL: nodejs#54777
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
marco-ippolito
added
the
dont-land-on-v20.x
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For historical reasons and to maintain compatibility with legacy database schemas, SQLite does not enable foreign key constraints by default. For new applications, however, this behavior is undesirable. Currently, any application that wishes to use foreign keys must use
to explicitly enable enforcement of such constraints.
This commit changes the behavior of the SQLite API built into Node.js to enable foreign key constraints by default. This behavior can be overridden by users to maintain compatibility with legacy database schemas.
I decided against using the compile-time option to set the default behavior to avoid limiting compatibility with third-party code that links against node's copy of SQLite.