Skip to content

sqlite: allow passing conflict resolution handler function #56352

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

Merged
nodejs-github-bot merged 12 commits into from
Dec 29, 2024
Merged

sqlite: allow passing conflict resolution handler function #56352

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
3635cd9
sqlite: pass conflict type to conflict resolution handler
louwers Dec 24, 2024
e6001b3
sqlite: improve error message when applying changeset fails
louwers Dec 24, 2024
a06a068
sqlite: handle exception thrown in conflict handler
louwers Dec 24, 2024
5d2fc4e
sqlite: avoid coercion when returning invalid value from conflict han…
louwers Dec 28, 2024
a45e4c0
sqlite: remove redundant header
louwers Dec 28, 2024
c4a03b5
doc: sqlite documentation improvements
louwers Dec 28, 2024
c674327
sqlite: improve error handling
louwers Dec 28, 2024
7ccdfd1
sqlite: add test returning Promise from conflict handler
louwers Dec 28, 2024
df86bb1
sqlite: fix error code key and add test
louwers Dec 28, 2024
eb1936b
sqlite: formatting
louwers Dec 28, 2024
9b4255c
sqlite: fix error message test
louwers Dec 28, 2024
5e39d22
doc: sort references
louwers Dec 28, 2024
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
Prev Previous commit
Next Next commit
doc: sqlite documentation improvements
  • Loading branch information
@louwers
louwers committed Dec 28, 2024
commit c4a03b5e37fa8f419e3dfc0aa103c49084de3416
15 changes: 11 additions & 4 deletions doc/api/sqlite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,7 +514,9 @@ The following constants are exported by the `sqlite.constants` object.

#### Conflict resolution constants

One of the following constants is available as an argument to the `onConflict` conflict resolution handler passed to [`database.applyChangeset()`](#databaseapplychangesetchangeset-options)). See also [Constants Passed To The Conflict Handler](https://www.sqlite.org/session/c_changeset_conflict.html) in the SQLite documentation.
One of the following constants is available as an argument to the `onConflict`
conflict resolution handler passed to [`database.applyChangeset()`][]. See also
[Constants Passed To The Conflict Handler]() in the SQLite documentation.

<table>
<tr>
Expand All @@ -535,15 +537,17 @@ One of the following constants is available as an argument to the `onConflict` c
</tr>
<tr>
<td><code>SQLITE_CHANGESET_CONSTRAINT</code></td>
<td>If foreign key handling is enabled, and applying a changeset leaves the database in a state containing foreign key violations, the conflict handler is invoked with this constant exactly once before the changeset is committed. If the conflict handler returns SQLITE_CHANGESET_OMIT, the changes, including those that caused the foreign key constraint violation, are committed. Or, if it returns SQLITE_CHANGESET_ABORT, the changeset is rolled back.</td>
<td>If foreign key handling is enabled, and applying a changeset leaves the database in a state containing foreign key violations, the conflict handler is invoked with this constant exactly once before the changeset is committed. If the conflict handler returns <code>SQLITE_CHANGESET_OMIT</code>, the changes, including those that caused the foreign key constraint violation, are committed. Or, if it returns <code>SQLITE_CHANGESET_ABORT</code>, the changeset is rolled back.</td>
</tr>
<tr>
<td><code>SQLITE_CHANGESET_FOREIGN_KEY</code></td>
<td>If any other constraint violation occurs while applying a change (i.e. a UNIQUE, CHECK or NOT NULL constraint), the conflict handler is invoked with this constant.</td>
</tr>
</table>

One of the following constants must be returned from the `onConflict` conflict resolution handler passed to [`database.applyChangeset()`](#databaseapplychangesetchangeset-options). See also [Constants Returned From The Conflict Handler](https://www.sqlite.org/session/c_changeset_abort.html) in the SQLite documentation.
One of the following constants must be returned from the `onConflict` conflict
resolution handler passed to [`database.applyChangeset()`][]. See also
[Constants Returned From The Conflict Handler][] in the SQLite documentation.

<table>
<tr>
Expand All @@ -556,7 +560,7 @@ One of the following constants must be returned from the `onConflict` conflict r
</tr>
<tr>
<td><code>SQLITE_CHANGESET_REPLACE</code></td>
<td>Conflicting changes replace existing values. Note that this value can only be returned when the type of conflict is either `SQLITE_CHANGESET_DATA` or `SQLITE_CHANGESET_CONFLICT`.</td>
<td>Conflicting changes replace existing values. Note that this value can only be returned when the type of conflict is either <code>SQLITE_CHANGESET_DATA</code> or <code>SQLITE_CHANGESET_CONFLICT</code>.</td>
</tr>
<tr>
<td><code>SQLITE_CHANGESET_ABORT</code></td>
Expand All @@ -565,6 +569,9 @@ One of the following constants must be returned from the `onConflict` conflict r
</table>

[Changesets and Patchsets]: https://www.sqlite.org/sessionintro.html#changesets_and_patchsets
[`database.applyChangeset()`]: #databaseapplychangesetchangeset-options
[Constants Passed To The Conflict Handler]: https://www.sqlite.org/session/c_changeset_conflict.html
[Constants Returned From The Conflict Handler]: https://www.sqlite.org/session/c_changeset_abort.html
[SQL injection]: https://en.wikipedia.org/wiki/SQL_injection
[`ATTACH DATABASE`]: https://www.sqlite.org/lang_attach.html
[`PRAGMA foreign_keys`]: https://www.sqlite.org/pragma.html#pragma_foreign_keys
Expand Down